Skip to content

List Incident Update Templates

Request

Filters and returns Incident Template 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"
deletedstring

Filters templates by deletion status:

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

Filters Incident templates by incident type value.
Comma-separated incident types.
Allowed incident types:

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

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

  • title,
  • body,
  • one of the labels.
q_labelstring

String that filters templates to those containing the search string in one of the labels.

sort_propstring

Determines which property results should be sorted by.

Default:"created_at"
Value:"created_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}/incident_templates?created_by_me=true&deleted=true&incident_types=string&q=string&q_label=string&sort_prop=created_at&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
Response
{
  "current_page": 1,
  "page_count": 4,
  "per_page": 25,
  "total": 1024,
  "data": [
    { … }
  ]
}