Sign in

v1

latestOpenAPI 3.0.12026-07-233010767.7 KB
Status Pages

Get status pages.

get/status-pages

Query parameters

start-indexinteger

an integer specifying the starting point (beginning with 0) when paging through a list of entities

max-resultsinteger

the maximum number of results when paging through a list of status pages.

includestring[]

Describes optional properties that should be included in the response. You may declare multiple. (subscribed)

Response

The status pages

idnumber
namestring
domainstring
subdomainstring
timezone'Europe/Berlin' | 'America/New_York' | 'America/Los_Angeles' | 'Asia/Istanbul'
faviconUrlstring
logoUrlstring
visibility'PRIVATE' | 'PUBLIC'
hiddenFromSearchboolean
showSubscribeActionboolean
showIncidentHistoryOptionboolean
pageTitlestring
pageDescriptionstring
logoRedirectUrlstring
activatedboolean
status'OPERATIONAL' | 'UNDER_MAINTENANCE' | 'DEGRADED' | 'PARTIAL_OUTAGE' | 'MAJOR_OUTAGE'

the service status

ipWhiteliststring[]

ipv4 or ipv6 addresses to give access to. Can only be set on 'PRIVATE' status pages

subscribedboolean

This is an include field, it is not available in the list resource

announcementstring

This is an include field, it is not available in the list resource

announcementOnPageboolean

If the announcement should be displayed on the status page

announcementInWidgetboolean

If the announcement should be displayed in the popup widget

audienceSpecificboolean

If a private status page should move into audience specific mode