Grafana OnCallGrafana OnCall API referenceEscalation Chains HTTP API

Create an escalation chain

curl "{{API_URL}}/api/v1/escalation_chains/" \
  --request POST \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json" \
  --data '{
      "name": "example-chain"
  }'

The above command returns JSON structured like this:

{
    "id": "FWDL7M6N6I9HE",
    "name": "example-chain",
    "team_id": null
}
ParameterRequiredDescription
nameyesName of the escalation chain
team_idnoID of the team

HTTP request

POST {{API_URL}}/api/v1/escalation_chains/

Get an escalation chain

curl "{{API_URL}}/api/v1/escalation_chains/F5JU6KJET33FE/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json"

The above command returns JSON structured like this:

{
    "id": "F5JU6KJET33FE",
    "name": "default",
    "team_id": null
}

HTTP request

GET {{API_URL}}/api/v1/escalation_chains/<ESCALATION_CHAIN_ID>/

List escalation chains

curl "{{API_URL}}/api/v1/escalation_chains/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json" 

The above command returns JSON structured like this:

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "F5JU6KJET33FE",
            "name": "default",
            "team_id": null
        }
    ]
}

HTTP request

GET {{API_URL}}/api/v1/escalation_chains/

Delete an escalation chain

curl "{{API_URL}}/api/v1/escalation_chains/F5JU6KJET33FE/" \
  --request DELETE \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json"

HTTP request

DELETE {{API_URL}}/api/v1/escalation_chains/<ESCALATION_CHAIN_ID>/