Deploys
Use these operations to interact with deploys in Cortex.
Required permissions
Edit entities: Your API key must have the Edit entities
permission.
Operations
The tag (x-cortex-tag
) or unique, auto-generated identifier for the entity.
Number of results to return per page, between 1 and 1000. Default 250.
250
Page number to return, 0-indexed. Default 0.
0
Successfully retrieved deployments
Entity not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/catalog/{tagOrId}/deploys HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"deployments": [
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"deployer": {
"email": "text",
"name": "text"
},
"environment": "text",
"sha": "text",
"timestamp": "2025-09-12T13:04:28.289Z",
"title": "text",
"type": "DEPLOY",
"url": "https://cortex.io",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"page": 1,
"total": 1,
"totalPages": 1
}
The tag (x-cortex-tag
) or unique, auto-generated identifier for the entity.
Successfully created deployment
Entity not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/catalog/{tagOrId}/deploys HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 204
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"deployer": {
"email": "text",
"name": "text"
},
"environment": "text",
"sha": "text",
"timestamp": "2025-09-12T13:04:28.289Z",
"title": "text",
"type": "DEPLOY",
"url": "text"
}
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"deployerEmail": "text",
"deployerName": "text",
"environment": "text",
"id": 1,
"serviceId": 1,
"sha": "text",
"timestamp": "2025-09-12T13:04:28.289Z",
"title": "text",
"type": "DEPLOY",
"url": "text",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
The tag (x-cortex-tag
) or unique, auto-generated identifier for the entity.
Successfully updated deployment
Entity or deployment not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
PUT /api/v1/catalog/{tagOrId}/deploys/{uuid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 204
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"deployer": {
"email": "text",
"name": "text"
},
"environment": "text",
"sha": "text",
"timestamp": "2025-09-12T13:04:28.289Z",
"title": "text",
"type": "DEPLOY",
"url": "text"
}
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"deployerEmail": "text",
"deployerName": "text",
"environment": "text",
"id": 1,
"serviceId": 1,
"sha": "text",
"timestamp": "2025-09-12T13:04:28.289Z",
"title": "text",
"type": "DEPLOY",
"url": "text",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
Dangerous endpoint that blows away deploys for all entities
Successfully deleted all deployments
Bad Request
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/catalog/deploys/all HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"deploys": [
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"deployer": {
"email": "text",
"name": "text"
},
"environment": "text",
"sha": "text",
"timestamp": "2025-09-12T13:04:28.289Z",
"title": "text",
"type": "DEPLOY",
"url": "https://cortex.io",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
]
}
The tag (x-cortex-tag
) or unique, auto-generated identifier for the entity.
Successfully deleted deployments
Entity not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/catalog/{tagOrId}/deploys HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"deployerEmail": "text",
"deployerName": "text",
"environment": "text",
"id": 1,
"serviceId": 1,
"sha": "text",
"timestamp": "2025-09-12T13:04:28.289Z",
"title": "text",
"type": "DEPLOY",
"url": "text",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
The tag (x-cortex-tag
) or unique, auto-generated identifier for the entity.
Successfully deleted deployment
Entity or deployment not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/catalog/{tagOrId}/deploys/{uuid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"deployerEmail": "text",
"deployerName": "text",
"environment": "text",
"id": 1,
"serviceId": 1,
"sha": "text",
"timestamp": "2025-09-12T13:04:28.289Z",
"title": "text",
"type": "DEPLOY",
"url": "text",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
Filter and delete deploys by SHA hash, environment, or type. Note that at least one of the filters need to be set. If looking to delete all deployments for an entity, use the Delete all deploys for entity
endpoint instead.
Successfully deleted deployment
Trying to delete deploys without any filters
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/catalog/deploys HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"deploys": [
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"deployer": {
"email": "text",
"name": "text"
},
"environment": "text",
"sha": "text",
"timestamp": "2025-09-12T13:04:28.289Z",
"title": "text",
"type": "DEPLOY",
"url": "https://cortex.io",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
]
}
Last updated
Was this helpful?