Grafana OnCallGrafana OnCall API referencePostmortem Messages HTTP API

Create a postmortem message

curl "{{API_URL}}/api/v1/postmortem_messages/" \
  --request POST \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json" \
  --data '{
      "incident_id": "I68T24C13IFW1",
      "text": "Demo postmortem message"
  }'

The above command returns JSON structured like this:

{
    "id": "M4BTQUS3PRHYQ",
    "incident_id": "I68T24C13IFW1",
    "author": "U4DNY931HHJS5",
    "source": "web",
    "created_at": "2020-06-19T12:40:01.429805Z",
    "text": "Demo postmortem message"
}

HTTP request

POST {{API_URL}}/api/v1/postmortem_messages/

Get a postmortem message

curl "{{API_URL}}/api/v1/postmortem_messages/M4BTQUS3PRHYQ/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json"

The above command returns JSON structured like this:

{
    "id": "M4BTQUS3PRHYQ",
    "incident_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/postmortem_messages/<POSTMORTEM_MESSAGE_ID>/

List postmortem messages

curl "{{API_URL}}/api/v1/postmortem_messages/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json"

The above command returns JSON structured like this:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "M4BTQUS3PRHYQ",
            "incident_id": "I68T24C13IFW1",
            "author": "U4DNY931HHJS5",
            "source": "web",
            "created_at": "2020-06-19T12:40:01.429805Z",
            "text": "Demo postmortem message"
        }
    ]
}

The following available filter parametershould be provided asget` argument:

  • incident_id

HTTP request

GET {{API_URL}}/api/v1/postmortem_messages/

Update a postmortem message

curl "{{API_URL}}/api/v1/postmortem_messages/M4BTQUS3PRHYQ/" \
  --request PUT \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json" \
  --data '{
      "text": "Demo postmortem message"
  }'

The above command returns JSON structured like this:

{
    "id": "M4BTQUS3PRHYQ",
    "incident_id": "I68T24C13IFW1",
    "author": "U4DNY931HHJS5",
    "source": "web",
    "created_at": "2020-06-19T12:40:01.429805Z",
    "text": "Demo postmortem message"
}

HTTP request

PUT {{API_URL}}/api/v1/postmortem_messages/<POSTMORTEM_MESSAGE_ID>/

Delete a postmortem message

curl "{{API_URL}}/api/v1/postmortem_messages/M4BTQUS3PRHYQ/" \
  --request DELETE \
  --header "Authorization: meowmeowmeow"

HTTP request

DELETE {{API_URL}}/api/v1/postmortem_messages/<POSTMORTEM_MESSAGE_ID>/