post
https://api.ol-hub.com/backend/api/v1/projects//deploy
The deploy project API sends a POST request to start a service.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Prerequisites
- The caller must provide a project id.
Authorization
- API key (via the
X-API-KEYheader).
Parameters
Path Parameters
| Field name | Description | Format |
|---|---|---|
| id | The ID of the project | UUID |
Query Parameters
| Field name | Description | Format |
|---|---|---|
| version | The project version | String |
| deployer | The deployer | String |
| profile | The deployer profile | String |
Request Body
| Field name | Description | Format |
|---|---|---|
| environmentType | The deployment environment type | String |
| activeProfiles | Active profiles | Array |
| configurationVariables | Configuration variables | Array |
| applicationName | The deployment application name | String |
Configuration Variable Structure
| Field name | Description | Format |
|---|---|---|
| name | The configuration name | String |
| type | The configuration type | String |
| default | The configuration default | Object |
Response Body
| Field name | Description | Format |
|---|---|---|
| id | The ID of the deployment service | UUID |
| status | The deployment status | String |
Examples
{
"environmentType": "TEST",
"activeProfiles": [
"$default"
],
"configurationVariables": [
{
"name": "VARIABLE",
"type": "INTEGER",
"default": 0
}
],
"applicationName": "deployment-name"
}{
"id": "00000000-0000-0000-0000-000000004444",
"status": "STARTED"
}