Routes HTTP API
Create a route
Required permission: grafana-oncall-app.integrations:write
curl "{{API_URL}}/api/v1/routes/" \
--request POST \
--header "Authorization: meowmeowmeow" \
--header "Content-Type: application/json" \
--data '{
"integration_id": "CFRPV98RPR1U8",
"escalation_chain_id": "F5JU6KJET33FE",
"routing_regex": "us-(east|west)",
"position": 0,
"slack": {
"channel_id": "CH23212D"
}
}'
The above command returns JSON structured in the following way:
{
"id": "RIYGUJXCPFHXY",
"integration_id": "CFRPV98RPR1U8",
"escalation_chain_id": "F5JU6KJET33FE",
"routing_regex": "us-(east|west)",
"position": 0,
"is_the_last_route": false,
"slack": {
"channel_id": "CH23212D"
}
}
Routes allow you to direct different alerts to different messenger channels and escalation chains. Useful for:
- Important/non-important alerts
- Alerts for different engineering groups
- Snoozing spam & debugging alerts
HTTP request
POST {{API_URL}}/api/v1/routes/
Get a route
Required permission: grafana-oncall-app.integrations:read
curl "{{API_URL}}/api/v1/routes/RIYGUJXCPFHXY/" \
--request GET \
--header "Authorization: meowmeowmeow" \
--header "Content-Type: application/json" \
The above command returns JSON structured in the following way:
{
"id": "RIYGUJXCPFHXY",
"integration_id": "CFRPV98RPR1U8",
"escalation_chain_id": "F5JU6KJET33FE",
"routing_regex": "us-(east|west)",
"position": 0,
"is_the_last_route": false,
"slack": {
"channel_id": "CH23212D"
}
}
HTTP request
GET {{API_URL}}/api/v1/routes/<ROUTE_ID>/
List routes
Required permission: grafana-oncall-app.integrations:read
curl "{{API_URL}}/api/v1/routes/" \
--request GET \
--header "Authorization: meowmeowmeow" \
--header "Content-Type: application/json"
The above command returns JSON structured in the following way:
Note: The response is paginated. You may need to make multiple requests to get all records.
The following available filter parameters should be provided as GET
arguments:
integration_id
routing_regex
(Exact match)
HTTP request
GET {{API_URL}}/api/v1/routes/
Update route
Required permission: grafana-oncall-app.integrations:write
curl "{{API_URL}}/api/v1/routes/RIYGUJXCPFHXY/" \
--request PUT \
--header "Authorization: meowmeowmeow" \
--header "Content-Type: application/json" \
--data '{
"routing_regex": "us-(east|west)",
"position": 0,
"slack": {
"channel_id": "CH23212D"
}
}'
The above command returns JSON structured in the following way:
{
"id": "RIYGUJXCPFHXY",
"integration_id": "CFRPV98RPR1U8",
"escalation_chain_id": "F5JU6KJET33FE",
"routing_regex": "us-(east|west)",
"position": 0,
"is_the_last_route": false,
"slack": {
"channel_id": "CH23212D"
}
}
HTTP request
PUT {{API_URL}}/api/v1/routes/<ROUTE_ID>/
Delete a route
Required permission: grafana-oncall-app.integrations:write
curl "{{API_URL}}/api/v1/routes/RIYGUJXCPFHXY/" \
--request DELETE \
--header "Authorization: meowmeowmeow" \
--header "Content-Type: application/json"
HTTP request
DELETE {{API_URL}}/api/v1/routes/<ROUTE_ID>/