Skip to main content
GET
Retrieve on-call registration for entity

Authorizations

Authorization
string
header
required

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path Parameters

tagOrId
string
required

The tag (x-cortex-tag) or unique, auto-generated identifier (CID) for the entity. If the tag contains forward slashes, URL-encode each / as %2F. The tag is matched exactly as encoded, including leading, trailing, and consecutive slashes, which are preserved and not collapsed (for example, the tag /services/payments-api is referenced as %2Fservices%2Fpayments-api). Tags containing slashes are supported via the API but not in the Cortex UI; this difference is expected. Entity identifier - can be a tag or CID

Response

Successfully retrieved on-call registration

id
string
required

Registration ID

Example:

"ASDF1234"

provider
enum<string>
required

Integration

Available options:
OPSGENIE,
PAGERDUTY,
VICTOROPS,
XMATTERS,
INCIDENTIO,
DATADOG
Example:

"OPSGENIE, PAGERDUTY, VICTOROPS"

source
enum<string>
required

Source

Available options:
AUTO_MAPPED,
DEFINED
Example:

"AUTO_MAPPED, DEFINED"

type
enum<string>
required
Available options:
CQL_FILTER,
SERVICE_FILTER,
RESOURCE_FILTER,
DOMAIN_FILTER,
TEAM_FILTER,
COMPOUND_FILTER
Last modified on September 29, 2026