6b40f95033
Co-authored-by: Eve832 <eve.meelan@grafana.com>
Co-authored-by: Francisco Montes de Oca <nevermind89x@gmail.com>
Co-authored-by: Ildar Iskhakov <ildar.iskhakov@grafana.com>
Co-authored-by: Innokentii Konstantinov <innokenty.konstantinov@grafana.com>
Co-authored-by: Julia <ferril.darkdiver@gmail.com>
Co-authored-by: maskin25 <kengurek@gmail.com>
Co-authored-by: Matias Bordese <mbordese@gmail.com>
Co-authored-by: Matvey Kukuy <motakuk@gmail.com>
Co-authored-by: Michael Derynck <michael.derynck@grafana.com>
Co-authored-by: Richard Hartmann <richih@richih.org>
Co-authored-by: Robby Milo <robbymilo@fastmail.com>
Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
Co-authored-by: Vadim Stepanov <vadimkerr@gmail.com>
Co-authored-by: Yulia Shanyrova <yulia.shanyrova@grafana.com>
102 lines
No EOL
2 KiB
Markdown
102 lines
No EOL
2 KiB
Markdown
+++
|
|
title = "Escalation Chains HTTP API"
|
|
aliases = ["/docs/grafana-cloud/oncall/oncall-api-reference/escalation_chains"]
|
|
weight = 200
|
|
+++
|
|
|
|
# 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
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
**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>/` |