Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation

OnCall

API reference

Escalation chains HTTP API

Open source

Escalation 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 in the following way:

{
  "id": "FWDL7M6N6I9HE",
  "name": "example-chain",
  "team_id": null
}

Parameter	Required	Description
name	yes	Name of the escalation chain
team_id	no	ID 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 in the following way:

{
  "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 in the following way:

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "F5JU6KJET33FE",
      "name": "default",
      "team_id": null
    }
  ],
  "current_page_number": 1,
  "page_size": 50,
  "total_pages": 1
}

Note: The response is paginated. You may need to make multiple requests to get all records.

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>/