c5b76a5869
# What this PR does The right-hand side navigation in the OnCall API public docs ([example](https://grafana.com/docs/oncall/latest/oncall-api-reference/alertgroups/)) doesn’t render as expected vs. what we see in the Grafana API public docs ([example](https://grafana.com/docs/grafana/latest/developers/http_api/folder/); 2nd screenshot). This PR fixes that ([convo on Slack](https://raintank-corp.slack.com/archives/C045CTY1QEP/p1718388424649359)).  
107 lines
2.1 KiB
Markdown
107 lines
2.1 KiB
Markdown
---
|
|
canonical: https://grafana.com/docs/oncall/latest/oncall-api-reference/escalation_chains/
|
|
title: Escalation chains HTTP API
|
|
weight: 200
|
|
---
|
|
|
|
# Escalation chains HTTP API
|
|
|
|
## Create an escalation chain
|
|
|
|
```shell
|
|
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:
|
|
|
|
```json
|
|
{
|
|
"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
|
|
|
|
```shell
|
|
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:
|
|
|
|
```json
|
|
{
|
|
"id": "F5JU6KJET33FE",
|
|
"name": "default",
|
|
"team_id": null
|
|
}
|
|
```
|
|
|
|
**HTTP request**
|
|
|
|
`GET {{API_URL}}/api/v1/escalation_chains/<ESCALATION_CHAIN_ID>/`
|
|
|
|
## List escalation chains
|
|
|
|
```shell
|
|
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:
|
|
|
|
```json
|
|
{
|
|
"count": 2,
|
|
"next": null,
|
|
"previous": null,
|
|
"results": [
|
|
{
|
|
"id": "F5JU6KJET33FE",
|
|
"name": "default",
|
|
"team_id": null
|
|
}
|
|
],
|
|
"current_page_number": 1,
|
|
"page_size": 50,
|
|
"total_pages": 1
|
|
}
|
|
```
|
|
|
|
**HTTP request**
|
|
|
|
`GET {{API_URL}}/api/v1/escalation_chains/`
|
|
|
|
## Delete an escalation chain
|
|
|
|
```shell
|
|
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>/`
|