Api Deployment API
List http api deployment by domain in the environment
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/http-api-deployments | GET | Yes |
Example Response JSON
{
"values": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"domain": "string",
"hash": "string",
"agents": {
"property1": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
},
"property2": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
}
},
"webhooksUrl": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
]
}Create a new api-deployment in the environment
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/http-api-deployments | POST | Yes |
Example Request JSON
{
"domain": "string",
"webhooksUrl": "string",
"agents": {
"property1": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
},
"property2": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
}
}
}Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"domain": "string",
"hash": "string",
"agents": {
"property1": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
},
"property2": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
}
},
"webhooksUrl": "string",
"createdAt": "2019-08-24T14:15:22Z"
}Get an api-deployment by id
| Path | Method | Protected |
|---|---|---|
/v1/http-api-deployments/{http_api_deployment_id} | GET | Yes |
Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"domain": "string",
"hash": "string",
"agents": {
"property1": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
},
"property2": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
}
},
"webhooksUrl": "string",
"createdAt": "2019-08-24T14:15:22Z"
}Delete an api-deployment
| Path | Method | Protected |
|---|---|---|
/v1/http-api-deployments/{http_api_deployment_id} | DELETE | Yes |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| current_revision | integer | Yes | - |
Update an api-deployment
| Path | Method | Protected |
|---|---|---|
/v1/http-api-deployments/{http_api_deployment_id} | PATCH | Yes |
Example Request JSON
{
"currentRevision": 0,
"webhookUrl": "string",
"agents": {
"property1": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
},
"property2": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
}
}
}Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"domain": "string",
"hash": "string",
"agents": {
"property1": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
},
"property2": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
}
},
"webhooksUrl": "string",
"createdAt": "2019-08-24T14:15:22Z"
}Get a specific http api deployment revision
| Path | Method | Protected |
|---|---|---|
/v1/http-api-deployment/{http_api_deployment_id}/revisions/{revision} | GET | Yes |
Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"domain": "string",
"hash": "string",
"agents": {
"property1": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
},
"property2": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
}
},
"webhooksUrl": "string",
"createdAt": "2019-08-24T14:15:22Z"
}Get http api deployment by domain in the environment
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/http-api-deployments/{domain} | GET | Yes |
Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"domain": "string",
"hash": "string",
"agents": {
"property1": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
},
"property2": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
}
},
"webhooksUrl": "string",
"createdAt": "2019-08-24T14:15:22Z"
}Get http api deployment by domain in the deployment
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/deployments/{deployment_revision}/http-api-deployments/{domain} | GET | Yes |
Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"domain": "string",
"hash": "string",
"agents": {
"property1": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
},
"property2": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
}
},
"webhooksUrl": "string",
"createdAt": "2019-08-24T14:15:22Z"
}Get http api deployment by domain in the deployment
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/deployments/{deployment_revision}/http-api-deployments | GET | Yes |
Example Response JSON
{
"values": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"domain": "string",
"hash": "string",
"agents": {
"property1": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
},
"property2": {
"security": {
"type": "TestSessionHeader",
"headerName": "string"
}
}
},
"webhooksUrl": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
]
}Api Deployment API Errors
| Status Code | Description | Body |
|---|---|---|
| 400 | Invalid request, returning with a list of issues detected in the request | {"code":"string","errors":["string"]} |
| 401 | Unauthorized request | {"code":"string","error":"string"} |
| 403 | Forbidden Request | {"code":"string","error":"string"} |
| 404 | Entity not found | {"code":"string","error":"string"} |
| 409 | {"code":"string","error":"string"} | |
| 422 | Limits of the plan exceeded | {"code":"string","error":"string"} |
| 500 | Internal server error | {"code":"string","error":"string"} |