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>
3.3 KiB
+++ title = "Postmortem HTTP API" aliases = ["/docs/grafana-cloud/oncall/oncall-api-reference/postmortems/"] weight = 1000 draft = true +++
Create a postmortem
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:
{
"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
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:
{
"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
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:
{
"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
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:
{
"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
curl "{{API_URL}}/api/v1/postmortems/P658FE5K87EWZ/" \
--request DELETE \
--header "Authorization: meowmeowmeow"
HTTP request
DELETE {{API_URL}}/api/v1/postmortems/<POSTMORTEM_ID>/