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

API Keys

Last updated 1 month ago

Was this helpful?

Use these operations to interact with in Cortex.

Required permissions

Your API token must have the Edit API keys permission.

API keys

List API keys

get

List API keys

The API key used to make the request must have the Edit API keys permission

Authorizations
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 found API keys
400
Bad request
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/auth/key HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
  "apiKeys": [
    {
      "cid": "ak1234567890abcdef",
      "createdDate": "2025-01-15T22:47:30Z",
      "description": "API Key used for entities scanner script",
      "expirationDate": "2025-05-20T05:10:41.709Z",
      "last4": "0kAg",
      "name": "Entities scanner",
      "roles": [
        {
          "role": "READ_ONLY",
          "type": "text"
        }
      ]
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Get API key

get

Get API key

Authorizations
Path parameters
cidstringRequired

The unique, auto-generated identifier for the API key

Example: ak1234567890abcdef
Responses
200
Successfully found API key
400
Bad request
404
API key not found
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/auth/key/{cid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
  "cid": "ak1234567890abcdef",
  "createdDate": "2025-01-15T22:47:30Z",
  "description": "API Key used for entities scanner script",
  "expirationDate": "2025-05-20T05:10:41.709Z",
  "last4": "0kAg",
  "name": "Entities scanner",
  "roles": [
    {
      "role": "READ_ONLY",
      "type": "text"
    }
  ]
}

Delete API key

delete

Delete API key

The API key used to make the request must have the Edit API keys permission

Authorizations
Path parameters
cidstringRequired

The unique, auto-generated identifier for the API key

Example: ak1234567890abcdef
Responses
200
Successfully deleted API key
400
Bad request
403
Access denied
404
API key not found
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/auth/key/{cid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

  • Required permissions
  • GETList API keys
  • GETGet API key
  • POSTCreate API key
  • PUTUpdate API key
  • DELETEDelete API key

Create API key

post

Create new API key.

The API key used to make the request must have the Edit API keys permission

Authorizations
Body
descriptionstringOptional

Description of the API key

Example: API Key used for entities scanner script
expirationDatestring ยท date-timeOptional

Expiration date of the API key. Format: ISO8601 with timezone offset

namestringRequired

Name of the API key

Example: Entities scanner
Responses
200
Successfully created API key
400
Bad request
403
Access denied
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/auth/key HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "description": "API Key used for entities scanner script",
  "expirationDate": "2025-05-20T05:10:41.709Z",
  "name": "Entities scanner",
  "roles": [
    {
      "role": "READ_ONLY",
      "type": "text"
    }
  ]
}
{
  "apiKey": "3WpQ3WpQ3WpQ3WpQ",
  "description": "API Key used for entities scanner script",
  "expirationDate": "2025-05-20T05:10:41.709Z",
  "name": "Entities scanner",
  "roles": [
    {
      "role": "READ_ONLY",
      "type": "text"
    }
  ]
}

Update API key

put

Update API key

The API key used to make the request must have the Edit API keys permission

Authorizations
Path parameters
cidstringRequired

The unique, auto-generated identifier for the API key

Example: ak1234567890abcdef
Body
descriptionstringOptional

Description of the API key

Example: API Key used for entities scanner script
namestringRequired

Name of the API key

Example: Entities scanner
Responses
200
Successfully updated API key
400
Bad request
403
Access denied
404
API key not found
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/auth/key/{cid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "description": "API Key used for entities scanner script",
  "name": "Entities scanner"
}
{
  "cid": "ak1234567890abcdef",
  "createdDate": "2025-01-15T22:47:30Z",
  "description": "API Key used for entities scanner script",
  "expirationDate": "2025-05-20T05:10:41.709Z",
  "last4": "0kAg",
  "name": "Entities scanner",
  "roles": [
    {
      "role": "READ_ONLY",
      "type": "text"
    }
  ]
}