d3921a5386
If a page is removed in a future version, the presence of a "latest" absolute alias in a previous version can redirect that removed page. **Notes for reviewer:** I would like to make similar changes for older, previously published versions. I believe you are only publishing documentation on specific tag events and are not maintaining long lived release branches for backporting fixes into. If my understanding is correct, I will make the changes in the website repository (https://github.com/grafana/website/tree/master/content/docs/oncall). Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
152 lines
3.1 KiB
Markdown
152 lines
3.1 KiB
Markdown
---
|
|
canonical: https://grafana.com/docs/oncall/latest/oncall-api-reference/postmortems/
|
|
draft: true
|
|
title: Postmortem HTTP API
|
|
weight: 1000
|
|
---
|
|
|
|
# Create a postmortem
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/postmortems/" \
|
|
--request POST \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json" \
|
|
--data '{
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"text": "Demo postmortem text"
|
|
}'
|
|
```
|
|
|
|
The above command returns JSON structured in the following way:
|
|
|
|
```json
|
|
{
|
|
"id": "P658FE5K87EWZ",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"created_at": "2020-06-19T12:37:01.430444Z",
|
|
"text": "Demo postmortem text"
|
|
}
|
|
```
|
|
|
|
**HTTP request**
|
|
|
|
`POST {{API_URL}}/api/v1/postmortems/`
|
|
|
|
# Get a postmortem
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/postmortems/P658FE5K87EWZ/" \
|
|
--request GET \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json"
|
|
```
|
|
|
|
The above command returns JSON structured in the following way:
|
|
|
|
```json
|
|
{
|
|
"id": "P658FE5K87EWZ",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"created_at": "2020-06-19T12:37:01.430444Z",
|
|
"text": "Demo postmortem text",
|
|
"postmortem_messages": [
|
|
{
|
|
"id": "M4BTQUS3PRHYQ",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"author": "U4DNY931HHJS5",
|
|
"source": "web",
|
|
"created_at": "2020-06-19T12:40:01.429805Z",
|
|
"text": "Demo postmortem message"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
**HTTP request**
|
|
|
|
`GET {{API_URL}}/api/v1/postmortems/<POSTMORTEM_ID>/`
|
|
|
|
# List postmortems
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/postmortems/" \
|
|
--request GET \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json"
|
|
```
|
|
|
|
The above command returns JSON structured in the following way:
|
|
|
|
```json
|
|
{
|
|
"count": 1,
|
|
"next": null,
|
|
"previous": null,
|
|
"results": [
|
|
{
|
|
"id": "P658FE5K87EWZ",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"created_at": "2020-06-19T12:37:01.430444Z",
|
|
"text": "Demo postmortem text",
|
|
"postmortem_messages": [
|
|
{
|
|
"id": "M4BTQUS3PRHYQ",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"author": "U4DNY931HHJS5",
|
|
"source": "web",
|
|
"created_at": "2020-06-19T12:40:01.429805Z",
|
|
"text": "Demo postmortem message"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
The following available filter parameter should be provided with a `GET` argument:
|
|
|
|
- `alert_group_id`
|
|
|
|
**HTTP request**
|
|
|
|
`GET {{API_URL}}/api/v1/postmortems/`
|
|
|
|
# Update a postmortem
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/postmortems/P658FE5K87EWZ/" \
|
|
--request PUT \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json" \
|
|
--data '{
|
|
"text": "Demo postmortem text"
|
|
}'
|
|
```
|
|
|
|
The above command returns JSON structured in the following way:
|
|
|
|
```json
|
|
{
|
|
"id": "P658FE5K87EWZ",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"created_at": "2020-06-19T12:37:01.430444Z",
|
|
"text": "Demo postmortem text"
|
|
}
|
|
```
|
|
|
|
**HTTP request**
|
|
|
|
`PUT {{API_URL}}/api/v1/postmortems/<POSTMORTEM_ID>/`
|
|
|
|
# Delete a postmortem
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/postmortems/P658FE5K87EWZ/" \
|
|
--request DELETE \
|
|
--header "Authorization: meowmeowmeow"
|
|
```
|
|
|
|
**HTTP request**
|
|
|
|
`DELETE {{API_URL}}/api/v1/postmortems/<POSTMORTEM_ID>/`
|