Retrieve an Incident Update

Request

Returns data about single Incident Update event.

Security

ApiKeyAuth

Path

subdomainstringrequired

Unique subdomain of requested Hub.

incident_idintegerrequired

id of the requested incident.

incident_update_idintegerrequired

id of the requested incident update

Query

extendstring

Specifies which properties should be expanded.
Expanded properties contains more detailed information which is less frequently needed in typical usage.
Currently supported only for flags.

Example:extend=flags

api_versionstring

Api version

Value:"V3-R1"

curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}?extend=flags&api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

idinteger, >= 1

Example:25

authorstring or null

Author email

titlestring

Title of this update. May be different from current incident title.
Incident title may be changed during the duration of incident and therefore some updates may reflect previous title.

bodystring

Default:""

Example:"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"

created_atstring, (date-time)

Timestamp of record creation.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

start_timestring, (date-time)

Timestamps of a Incident Update.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

updated_atstring, (date-time)

Timestamp of last modification of record.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

incident_typestring

Type of Incident Update.
Exact meaning may depend on use case and there is just one restriction:
resolved can't be used as type of a first (by start_time) Incident Update.

Enum:"investigating""identified""monitoring""resolved"

Example:"investigating"

statestring or null

State of Incident or Incident Update:

draft - Not published on Hub Page,
unconfirmed - Published on Hub Page but marked as unconfirmed,
published - Published on Hub Page.

Default:"published"

Enum:"draft""unconfirmed""published"

Example:"published"

service_statusesArray of objects

flagsBasic flags (object) or Extended flags (object)

One of:

Response

{
  "id": 25,
  "author": "string",
  "title": "string",
  "body": "Message for an event or event update.<br>\nMay contain basic HTML tags.\n",
  "created_at": "2020-09-01T08:29:00Z",
  "start_time": "2020-09-01T08:29:00Z",
  "updated_at": "2020-09-01T08:29:00Z",
  "incident_type": "investigating",
  "state": "published",
  "service_statuses": [
    { … }
  ],
  "flags": {
    "deleted": true,
    "draft": true
  }
}