Retrieve an Incident

Request

Returns data about single Incident.

Security

ApiKeyAuth

Path

subdomainstringrequired

Unique subdomain of requested Hub.

incident_idintegerrequired

id of the requested incident.

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}?extend=flags&api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

idinteger, >= 1

Example:15

authorstring or null

Author email

titlestring

Title of incident as visible on Hub Page.
If there is draft IncidentUpdate that changes the title, the title will not reflect this change because the draft update is not published and therefore not visible on Hub Page.

created_atstring, (date-time)

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

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

start_timestring, (date-time)

Timestamp of the start_time of the first (by start_time) 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"

end_timestring or null, (date-time)

Timestamp of event end. If not set it means that the event has not ended yet.
ISO8601 formatted time (UTC).

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

flagsBasic flags (object) or Extended flags (object)

One of:

Response

{
  "id": 15,
  "author": "string",
  "title": "string",
  "created_at": "2020-09-01T08:29:00Z",
  "start_time": "2020-09-01T08:29:00Z",
  "updated_at": "2020-09-01T08:29:00Z",
  "end_time": "2020-09-01T08:29:00Z",
  "flags": {
    "deleted": true,
    "draft": true
  }
}