On call

Use these operations to interact with on-call information on entities in Cortex.

Required permissions

• Your API key must have the Edit entities permission.

Operations

Retrieve current on-call for entity

get

Authorizations

AuthorizationstringRequired

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

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Responses

200

Successfully retrieved current on-call

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/api/v1/catalog/{tagOrId}/integrations/oncall/current

GET /api/v1/catalog/{tagOrId}/integrations/oncall/current HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "current": [
      {
        "escalations": [
          {
            "escalationLevel": 1,
            "schedules": [
              {
                "user": {
                  "email": "[e-mail]",
                  "name": "Cristina Buenahora"
                }
              }
            ]
          }
        ],
        "provider": "OPSGENIE, PAGERDUTY, VICTOROPS"
      }
    ]
  }
]

Retrieve on-call registration for entity

get

Authorizations

AuthorizationstringRequired

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

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Responses

200

Successfully retrieved on-call registration

application/json

idstringRequired

Registration ID

Example: ASDF1234

providerstring · enumRequired

Integration

Example: OPSGENIE, PAGERDUTY, VICTOROPSPossible values:

sourcestring · enumRequired

Source

Example: AUTO_MAPPED, DEFINEDPossible values:

typestring · enumRequiredPossible values:

404

Entity or registration 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/api/v1/catalog/{tagOrId}/integrations/oncall/registration

GET /api/v1/catalog/{tagOrId}/integrations/oncall/registration HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "ASDF1234",
    "provider": "OPSGENIE, PAGERDUTY, VICTOROPS",
    "source": "AUTO_MAPPED, DEFINED",
    "type": "CQL_FILTER"
  }
]