API Keys

Use these operations to interact with API keys in Cortex.

Required permissions

Your API token must have the Edit API keys permission.

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 · int32 · default: 250required

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

pageinteger · int32 · default: 0required

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

Responses

application/jsonapplication/yaml

application/jsonapplication/yaml

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/auth/key?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

400

429

200

application/json

application/yaml

application/json

{
  "apiKeys": [
    {
      "cid": "ak1234567890abcdef",
      "createdDate": "2025-01-15T22:47:30Z",
      "description": "API Key used for entities scanner script",
      "expirationDate": "2025-03-29T00:32:36.906Z",
      "last4": "0kAg",
      "name": "Entities scanner",
      "roles": [
        {
          "role": "READ_ONLY",
          "type": "text"
        }
      ]
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Successfully found API keys

Get API key

get

Get API key

Authorizations

Path parameters

cidstringrequired

The unique, auto-generated identifier for the API key

Example: ak1234567890abcdef

Responses

application/jsonapplication/yaml

application/jsonapplication/yaml

application/jsonapplication/yaml

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/auth/key/{cid}' \
  --header 'Authorization: Bearer JWT'

200

400

404

429

200

application/json

application/yaml

application/json

{
  "cid": "ak1234567890abcdef",
  "createdDate": "2025-01-15T22:47:30Z",
  "description": "API Key used for entities scanner script",
  "expirationDate": "2025-03-29T00:32:36.906Z",
  "last4": "0kAg",
  "name": "Entities scanner",
  "roles": [
    {
      "role": "READ_ONLY",
      "type": "text"
    }
  ]
}

Successfully found 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

application/jsonapplication/yaml

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

rolesone of[]required

Roles assigned to the API key

Responses

application/jsonapplication/yaml

application/jsonapplication/yaml

application/jsonapplication/yaml

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/auth/key' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "API Key used for entities scanner script",
    "expirationDate": "2025-03-29T00:32:36.906Z",
    "name": "Entities scanner",
    "roles": [
      {
        "role": "READ_ONLY",
        "type": "text"
      }
    ]
  }'

application/jsonapplication/yaml

200

400

403

429

200

application/json

application/yaml

application/json

{
  "apiKey": "3WpQ3WpQ3WpQ3WpQ",
  "description": "API Key used for entities scanner script",
  "expirationDate": "2025-03-29T00:32:36.906Z",
  "name": "Entities scanner",
  "roles": [
    {
      "role": "READ_ONLY",
      "type": "text"
    }
  ]
}

Successfully created API key

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

application/jsonapplication/yaml

descriptionstringoptional

Description of the API key

Example: API Key used for entities scanner script

namestringrequired

Name of the API key

Example: Entities scanner

Responses

application/jsonapplication/yaml

application/jsonapplication/yaml

application/jsonapplication/yaml

application/jsonapplication/yaml

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/auth/key/{cid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "API Key used for entities scanner script",
    "name": "Entities scanner"
  }'

application/jsonapplication/yaml

200

400

403

404

429

200

application/json

application/yaml

application/json

{
  "cid": "ak1234567890abcdef",
  "createdDate": "2025-01-15T22:47:30Z",
  "description": "API Key used for entities scanner script",
  "expirationDate": "2025-03-29T00:32:36.906Z",
  "last4": "0kAg",
  "name": "Entities scanner",
  "roles": [
    {
      "role": "READ_ONLY",
      "type": "text"
    }
  ]
}

Successfully updated API key

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

application/jsonapplication/yaml

application/jsonapplication/yaml

application/jsonapplication/yaml

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/auth/key/{cid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

429

200

No body

Successfully deleted API key