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.
Create a route
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
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
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:
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"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"
}
},
{
"id": "RVBE4RKQSCGJ2",
"integration_id": "CFRPV98RPR1U8",
"escalation_chain_id": "F5JU6KJET33FE",
"routing_regex": ".*",
"position": 1,
"is_the_last_route": true,
"slack": {
"channel_id": "CH23212D"
}
}
],
"current_page_number": 1,
"page_size": 25,
"total_pages": 1
}
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
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
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>/