Queries

Use these operations to interact with CQL queries in Cortex.

Required permissions

Edit entities: Your API key must have the Enable Query builder permission.

Operations

Retrieve query results

get

Retrieve the status and results of a CQL query

Authorizations

Path parameters

jobIdstringrequired

jobId of the query to retrieve

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

429

200

{
  "progress": 1,
  "queryDetails": {
    "initiatedAt": "2025-03-29T00:36:45.903Z",
    "jobId": "text",
    "query": "text"
  },
  "result": [
    {
      "description": "text",
      "name": "text",
      "tag": "text",
      "type": "text"
    }
  ],
  "status": "IN_PROGRESS"
}

Successfully found query

Run query

post

Run a CQL query. For more information about the types of queries you can run, take a look at our CQL Explorer in the app.

Authorizations

Body

querystringrequired

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/queries' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "query": "text"
  }'

200

400

409

429

200

{
  "initiatedAt": "2025-03-29T00:36:45.903Z",
  "jobId": "text",
  "query": "text"
}

Successfully submitted query