Escalation policies HTTP API

Create an escalation policy

Required permission: grafana-irm-app.escalation-chains:write

curl "{{API_URL}}/api/v1/escalation_policies/" \
  --request POST \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json" \
  --header "X-Grafana-URL: https://your-stack.grafana.net" \
  --data '{
      "escalation_chain_id": "F5JU6KJET33FE",
      "type": "wait",
      "duration": 60
  }'

The above command returns JSON structured in the following way:

{
  "id": "E3GA6SJETWWJS",
  "escalation_chain_id": "F5JU6KJET33FE",
  "position": 0,
  "type": "wait",
  "duration": 60
}

Parameter	Required	Description
`escalation_chain_id`	Yes	Each escalation policy is assigned to a specific escalation chain.
`position`	Optional	Escalation policies execute one after another starting from `position=0`. `Position=-1` puts the policy at the end.
`type`	Yes	See Step types below.
`important`	Optional	Default `false`. Uses “important” notification rules. Applicable for user/schedule/group notification types.
`duration`	If type = `wait`	Duration in seconds (60-86400).
`action_to_trigger`	If type = `trigger_webhook`	ID of a webhook.
`group_to_notify`	If type = `notify_user_group`	ID of a User Group.
`persons_to_notify`	If type = `notify_persons`	List of user IDs.
`persons_to_notify_next_each_time`	If type = `notify_person_next_each_time`	List of user IDs.
`notify_on_call_from_schedule`	If type = `notify_*_from_schedule`	ID of a Schedule. See Schedule notification types below.
`notify_if_time_from`	If type = `notify_if_time_from_to`	UTC time for period start, e.g. `09:00:00Z`.
`notify_if_time_to`	If type = `notify_if_time_from_to`	UTC time for period end, e.g. `18:00:00Z`.
`num_alerts_in_window`	If type = `notify_if_num_alerts_in_window`	Number of alerts required to continue escalation.
`num_minutes_in_window`	If type = `notify_if_num_alerts_in_window`	Time window in minutes.
`team_to_notify`	If type = `notify_team_members`	ID of a team.
`severity`	If type = `declare_incident`	Severity of the incident.

Step types

wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, notify_user_group, notify_team_members, trigger_webhook, resolve, notify_whole_channel, notify_if_time_from_to, notify_if_num_alerts_in_window, repeat_escalation, declare_incident.

HTTP request

POST {{API_URL}}/api/v1/escalation_policies/

Get an escalation policy

Required permission: grafana-irm-app.escalation-chains:read

curl "{{API_URL}}/api/v1/escalation_policies/E3GA6SJETWWJS/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json" \
  --header "X-Grafana-URL: https://your-stack.grafana.net"

The above command returns JSON structured in the following way:

{
  "id": "E3GA6SJETWWJS",
  "escalation_chain_id": "F5JU6KJET33FE",
  "position": 0,
  "type": "wait",
  "duration": 60
}

Update an escalation policy

Required permission: grafana-irm-app.escalation-chains:write

curl "{{API_URL}}/api/v1/escalation_policies/E3GA6SJETWWJS/" \
  --request PUT \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json" \
  --header "X-Grafana-URL: https://your-stack.grafana.net" \
  --data '{
    "type": "wait",
    "duration": 300,
  }'

The above command returns JSON structured in the following way:

{
  "id": "E3GA6SJETWWJS",
  "escalation_chain_id": "F5JU6KJET33FE",
  "position": 0,
  "type": "wait",
  "duration": 300
}

HTTP request

PUT {{API_URL}}/api/v1/on_call_shifts/<ON_CALL_SHIFT_ID>/

HTTP request

GET {{API_URL}}/api/v1/escalation_policies/<ESCALATION_POLICY_ID>/

List escalation policies

Required permission: grafana-irm-app.escalation-chains:read

curl "{{API_URL}}/api/v1/escalation_policies/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json" \
  --header "X-Grafana-URL: https://your-stack.grafana.net"

The above command returns JSON structured in the following way:

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "E3GA6SJETWWJS",
      "escalation_chain_id": "F5JU6KJET33FE",
      "position": 0,
      "type": "wait",
      "duration": 60
    },
    {
      "id": "E5JJTU52M5YM4",
      "escalation_chain_id": "F5JU6KJET33FE",
      "position": 1,
      "type": "notify_person_next_each_time",
      "persons_to_notify_next_each_time": ["U4DNY931HHJS5"]
    }
  ],
  "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.

The following available filter parameter should be provided as a GET argument:

escalation_chain_id

HTTP request

GET {{API_URL}}/api/v1/escalation_policies/

Delete an escalation policy

Required permission: grafana-irm-app.escalation-chains:write

curl "{{API_URL}}/api/v1/escalation_policies/E3GA6SJETWWJS/" \
  --request DELETE \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json" \
  --header "X-Grafana-URL: https://your-stack.grafana.net"

HTTP request

DELETE {{API_URL}}/api/v1/escalation_policies/<ESCALATION_POLICY_ID>/