Skip to content

List Incidents

Request

Filters and returns Incident records for current Hub with basic info.

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

Query
created_by_mestring

Behavior:

  • true - filter events to only those which were created by current user,
  • false - filter events to only those which were not created by current user,
  • all - don't filter events by creator.
Default:"all"
Enum:"true""false""all"
draftstring

Filters events by presence of unpublished Incident Update:

  • true - return only events containing at least one unpublished (draft) Incident Update,
  • false - return only events without any unpublished Incident Updates,
  • all - return events without filtering by draft status.
Default:"false"
Enum:"true""false""all"
incident_typesstring

Comma-separated names of incident types.
Filters incidents by status of last (including draft) update. Examples:

  • incident_types=monitoring
  • incident_types=investigating,identified

Possible incident type values:

  • identified,
  • investigating,
  • monitoring,
  • resolved.

When not set, do not filter incidents by type of last update.

publishedstring

Filter events by status of publication on Hub Page:

  • true - return only events published on Hub Page,
  • false - return only events that were not published on Hub Page.
  • all - don't filter events by publication status.
Default:"all"
Enum:"true""false""all"
unconfirmedstring

Filter events by state of the event:

  • true - return only events were published as unconfirmed on Hub Page,
  • false - return only events were published as confirmed on Hub Page.
  • all - don't filter events by unconfirmed status.
Default:"all"
Enum:"true""false""all"
archivedstring

Filters incidents by archived status:

  • true - return only incidents that were archived,
  • false - return only incidents that were not archived,
  • all - return incidents without filtering by archived status.
Default:"false"
Enum:"true""false""all"
deletedstring

Filters incidents by deletion status:

  • true - return only incidents that were deleted,
  • false - return only incidents that were not deleted,
  • all - return incidents without filtering by deleted status.
Default:"false"
Enum:"true""false""all"
sort_propstring

Determines which property results should be sorted by.

Default:"start_time"
Enum:"created_at""start_time""updated_at"
sort_dirstring

Determines sorting direction.

Default:"desc"
Enum:"asc""desc"
period_namestring

Comma-separated period names.
Filters event by period name.

Examples:

  • period_name=current
  • period_name=past,current

Possible period name values:

  • past,
  • current.

When not set, do not filter by period.

service_idsstring

Comma-separated string of service ids.

Filters events by at least one affected service, specified in params.

Example: service_ids=1,2,3

statusesstring

Comma-separated string of service statuses names.

Filters events by at least one affected service with specified status.

Examples:

  • statuses=degraded-performance
  • statuses=up,down

Possible incident type values:

  • up
  • degraded-performance
  • down
start_timestring, (date-time)

Lower limit of the event start time filter.
ISO8601 formatted time (UTC).

Assumed as far in the past when not provided.
Combined with end_time filter events to those which period of occurrence (from event start_time to event end_time with end_time being far in the future for open incidents) overlaps with start_time and end_time params.

Default:"1900-01-01T00:00:00Z"
end_timestring, (date-time)

Upper limit of the event end time filter.
ISO8601 formatted time (UTC).

Assumed as far in the future when not provided.
Combined with start_time filter events to those which period of occurrence (from event start_time to event end_time with end_time being far in the future for open incidents) overlaps with start_time and end_time params.

Default:"2199-01-01T00:00:00Z"
qstring

String that filters events to those containing the search string in:

  • title,
  • body.
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
pageinteger, >= 1

Requested page index.

Default:1
per_pageinteger, [ 1 .. 100 ]

A limit on the number of records to be returned.

Default:25
api_versionstring

Api version

Value:"V3-R1"
curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/incidents?created_by_me=true&draft=true&incident_types=string&published=true&unconfirmed=true&archived=true&deleted=true&sort_prop=created_at&sort_dir=asc&period_name=string&service_ids=string&statuses=string&start_time=1900-01-01T00%3A00%3A00Z&end_time=2199-01-01T00%3A00%3A00Z&q=string&extend=flags&page=1&per_page=25&api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
current_pageinteger, >= 1
Example:1
page_countinteger, >= 1
Example:4
per_pageinteger, [ 1 .. 100 ]
Example:25
totalinteger, >= 0
Example:1024
dataArray of objects
Response
{
  "current_page": 1,
  "page_count": 4,
  "per_page": 25,
  "total": 1024,
  "data": [
    { … }
  ]
}