767c5352fa
# What this PR does This PR: - adds a few attributes to paginated API responses - removes channel filter "send demo alert" internal API endpoint + tests (this endpoint was marked as deprecated + not consumed by the web UI) With the new paginated API response schema, the web UI will no longer need to: - hardcode `ITEMS_PER_PAGE` for each table - manually calculate total number of pages (these two things ☝️ will be done in https://github.com/grafana/oncall/issues/2476) For `GET /api/internal/v1/alertgroups` the response will now look like this: ```diff { "next": <url> | None, "previous": <url> | None, "results": [], ++ "page_size": <int> } ``` For all other paginated API responses, the response will now look like: ```diff { "count": <int>, "next": <url> | None, "previous": <url> | None, "results": [], ++ "page_size": <int>, ++ "current_page_number": <int>, ++ "total_pages": <int> } ``` ## TODO - [x] update public API docs to include these new attributes ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required)
105 lines
2.1 KiB
Markdown
105 lines
2.1 KiB
Markdown
---
|
|
canonical: https://grafana.com/docs/oncall/latest/oncall-api-reference/escalation_chains/
|
|
title: Escalation Chains HTTP API
|
|
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
|
|
}
|
|
],
|
|
"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>/`
|