Deploys

Use these operations to interact with deploys in Cortex.

Required permissions

Edit entities: Your API key must have the Edit entities permission.

Operations

List deployments for entity

get

Authorizations

Path parameters

tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query parameters

pageSizeinteger · int32Required

Number of results to return per page, between 1 and 1000. Default 250.

Default: 250

pageinteger · int32Required

Page number to return, 0-indexed. Default 0.

Default: 0

Responses

200

Successfully retrieved deployments

application/json

404

Entity not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

HTTPcURLJavaScriptPython

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-05-20T05:29:49.533Z",
      "title": "text",
      "type": "DEPLOY",
      "url": "https://cortex.io",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Add deployment for entity

post

Authorizations

Path parameters

tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Body

environmentstringOptional

shastringOptional

timestampstring · date-timeRequired

titlestringRequired

typestring · enumRequiredPossible values:

urlstringOptional

Responses

200

Successfully created deployment

application/json

404

Entity not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

HTTPcURLJavaScriptPython

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-05-20T05:29:49.533Z",
  "title": "text",
  "type": "DEPLOY",
  "url": "text"
}

{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "deployerEmail": "text",
  "deployerName": "text",
  "environment": "text",
  "id": 1,
  "serviceId": 1,
  "sha": "text",
  "timestamp": "2025-05-20T05:29:49.533Z",
  "title": "text",
  "type": "DEPLOY",
  "url": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

Update deployment by UUID

put

Authorizations

Path parameters

tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

uuidstring · uuidRequired

Body

environmentstringOptional

shastringOptional

timestampstring · date-timeRequired

titlestringRequired

typestring · enumRequiredPossible values:

urlstringOptional

Responses

200

Successfully updated deployment

application/json

404

Entity or deployment not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

HTTPcURLJavaScriptPython

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-05-20T05:29:49.533Z",
  "title": "text",
  "type": "DEPLOY",
  "url": "text"
}

{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "deployerEmail": "text",
  "deployerName": "text",
  "environment": "text",
  "id": 1,
  "serviceId": 1,
  "sha": "text",
  "timestamp": "2025-05-20T05:29:49.533Z",
  "title": "text",
  "type": "DEPLOY",
  "url": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

Delete all deployments for all entities

delete

Dangerous endpoint that blows away deploys for all entities

Authorizations

Responses

200

Successfully deleted all deployments

application/json

400

Bad Request

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

HTTPcURLJavaScriptPython

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-05-20T05:29:49.533Z",
      "title": "text",
      "type": "DEPLOY",
      "url": "https://cortex.io",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Delete deployments for entity

delete

Authorizations

Path parameters

tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query parameters

environmentstringOptional

shastringOptional

typestring · enumOptionalPossible values:

Responses

200

Successfully deleted deployments

application/json

404

Entity not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

HTTPcURLJavaScriptPython

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-05-20T05:29:49.533Z",
  "title": "text",
  "type": "DEPLOY",
  "url": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

Delete deployment by UUID

delete

Authorizations

Path parameters

tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

uuidstring · uuidRequired

Responses

200

Successfully deleted deployment

application/json

404

Entity or deployment not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

HTTPcURLJavaScriptPython

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-05-20T05:29:49.533Z",
  "title": "text",
  "type": "DEPLOY",
  "url": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

Delete deploys by filter

delete

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.

Authorizations

Query parameters

environmentstringOptional

shastringOptional

typestring · enumOptionalPossible values:

Responses

200

Successfully deleted deployment

application/json

400

Trying to delete deploys without any filters

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

HTTPcURLJavaScriptPython

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-05-20T05:29:49.533Z",
      "title": "text",
      "type": "DEPLOY",
      "url": "https://cortex.io",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}