PHphare
Incidents

List incident updates

Changed on

Get a paginated list of the updates of an incident, the messages published on the status pages, newest first.

Requires the incidents:read permission.

get/uptime/incidents/{incidentId}/updates

Request

Path parameters

incidentIdinteger required

ID of the incident

Query parameters

pageinteger
Example:1

Page number to show

per_pageinteger
Example:20

Number of resources to return per page

Headers

X-Phare-Project-Idinteger
Example:1

A project header is required when using an organization-scoped API key.

X-Phare-Project-Slugstring
Example:luminous-guiding-tower

A project header is required when using an organization-scoped API key.

Response

Success, incident updates retrieved

Example response

{
  "data": [
    {
      "id": 1,
      "content": "We are investigating the issue.",
      "creator": {
        "id": 1,
        "type": "user",
        "label": "nicolas@phare.io"
      }
    }
  ],
  "meta": {
    "current_page": 2,
    "from": 11,
    "to": 20,
    "per_page": 100,
    "path": "https://api.phare.io/{resource}?page=2"
  },
  "links": {
    "first": "https://api.phare.io/{resource}?page=2",
    "last": "https://api.phare.io/{resource}?page=10",
    "prev": "https://api.phare.io/{resource}?page=1",
    "next": "https://api.phare.io/{resource}?page=1"
  }
}

Changes

  • 711f9af774a1Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

  • 7df8c52f3597Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API