LogoLogo
Login to CortexBook a DemoCortex Academycortex.io
  • Cortex Docs
  • Cortex Quick Start
  • Ingesting data into Cortex
    • Managing Entities
      • Adding entities
        • Add services
        • Add domains
        • Add teams
        • Add custom entity types
        • Defining dependencies
      • Entity details page
      • Defining ownership
      • Defining relationship types
      • Grouping entities
      • Adding external documentation
      • Adding Deploy data
      • Adding custom data
      • Viewing discovered entities
      • Archiving entities
      • Relationship graph
      • Using On-call Assistant for incidents
      • Managing Terraform infra in Cortex
    • Managing Catalogs
    • Integrations
      • Internally hosted integrations
      • ArgoCD
      • AWS
      • Azure DevOps
      • Azure Resources
      • BambooHR
      • Bitbucket
      • BugSnag
      • Buildkite
      • Checkmarx
      • CircleCI
      • ClickUp
      • Codecov
      • Coralogix
      • Custom webhook integrations
      • Datadog
      • Dynatrace
      • Entra ID (Azure AD)
      • FireHydrant
      • GitHub
      • GitLab
      • Google
      • Grafana
      • incident.io
      • Instana
      • Jenkins
      • Jira
      • Kubernetes
      • LaunchDarkly
      • Lightstep
      • Mend
      • Microsoft Teams
      • New Relic
      • Okta
      • Opsgenie
      • PagerDuty
      • Prometheus
      • Rollbar
      • Rootly
      • Sentry
      • ServiceNow
      • Slack
      • Snyk
      • SonarQube
      • Splunk Observability Cloud (SignalFx)
      • Splunk On-Call (VictorOps)
      • Sumo Logic
      • Veracode
      • Wiz
      • Workday
      • xMatters
  • Scorecards
    • Initiatives and Action items
      • Creating issues based on Initiatives
    • Scorecard rule exemptions
    • Scorecard rule filters
    • Scorecard examples
    • Scorecards as code
  • Reports
    • Executive report
    • All Scorecards report
    • Bird's eye report
    • Progress report
    • Report card
  • Eng Intelligence
    • Custom Metrics
    • Jira Metrics
    • Metrics Explorer (Beta)
  • Cortex Query Language (CQL)
    • Using CQL reports
    • Using JQ in Cortex
  • Workflows
    • Creating a Workflow
      • Workflows as code
    • Blocks
    • Running a Workflow
    • Registering a Scaffolder template
      • Scaffolder advanced usage
    • Using a Workflow to sync in ArgoCD
    • Kicking off a Jenkins pipeline in a Workflow
    • Calling internal service endpoints in a Workflow
  • Plugins
    • Creating a plugin
      • Creating a plugin proxy
    • Migrating Backstage plugins to Cortex
  • Engineering homepage
  • Workspace Settings
    • Using GitOps for Cortex
      • GitOps logs
    • Managing users
      • Roles and permissions
        • Custom roles
        • Team ownership entity editing
      • Configuring SSO
        • Microsoft Entra ID
        • Google
        • Other OIDC providers
        • Okta
          • Okta SCIM
      • Configuring identity mappings
      • Onboarding management
    • API keys, secrets, and tokens
      • Secrets
      • Personal tokens
    • Audit logs
    • Entity settings
      • Data verification
      • Auto archiving entities
    • IP allowlist
    • Notifications
      • Notification logs
    • Customizing your workspace
    • Using search in Cortex
  • Cortex API
    • REST API operations
      • API Keys
      • Audit Logs
      • Catalog Entities
      • Custom Data
        • Custom Data (Advanced)
      • Custom Events
      • Custom Metrics
      • Dependencies
      • Deploys
      • Discovery Audit
      • Docs
      • Eng Intel: User Labels
      • Entity Relationship Types (Beta)
      • Entity Relationships (Beta)
      • Entity Types
      • GitOps Logs
      • Groups
      • Initiatives
      • Integrations APIs
        • Azure Active Directory (Entra ID) API
        • Azure Resources API
        • AWS API
        • Azure DevOps API
        • CircleCI API
        • Coralogix API
        • Datadog API
        • GitHub API
        • GitLab API
        • incident.io API
        • LaunchDarkly API
        • New Relic API
        • PagerDuty API
        • Prometheus API
        • SonarQube API
      • IP Allowlist
      • Notification Logs
      • On call
      • Packages
      • Plugins
      • Queries
      • SCIM
      • Scorecards
      • Secrets
      • Team Hierarchies
      • Teams
      • Workflows
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Cortex API
  2. REST API operations

Deploys

Last updated 1 month ago

Was this helpful?

Use these operations to interact with in Cortex.

Required permissions

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

Operations

deploys

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
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
}

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
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
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
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
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"
    }
  ]
}
  • Required permissions
  • Operations
  • GETList deployments for entity
  • POSTAdd deployment for entity
  • PUTUpdate deployment by UUID
  • DELETEDelete all deployments for all entities
  • DELETEDelete deployments for entity
  • DELETEDelete deployment by UUID
  • DELETEDelete deploys by filter

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
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
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"
}