List Incident Updates

Request

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

Security

ApiKeyAuth

Path

subdomainstringrequired

Unique subdomain of requested Hub.

incident_idintegerrequired

id of the requested incident.

Query

archivedstring

Filters incident updates by archived status:

true - return only incident updates that were archived,
false - return only incident updates that were not archived,
all - return incident updates without filtering by archived status.

Default:"false"

Enum:"true""false""all"

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

sort_propstring

Determines which property results should be sorted by.

Default:"start_time"

Enum:"start_time""created_at""updated_at"

sort_dirstring

Determines sorting direction.

Default:"desc"

Enum:"asc""desc"

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/{incident_id}/incident_updates?archived=true&q=string&extend=flags&sort_prop=start_time&sort_dir=asc&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, <= 10 items

Response

{
  "current_page": 1,
  "page_count": 4,
  "per_page": 25,
  "total": 1024,
  "data": [
    { … }
  ]
}