v1

latestOpenAPI 3.0.12026-07-233010767.7 KB
Services

Get services.

get/services

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 services. (Note: when using ?include maximum is reduced to 25)

includestring[]

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

Response

The services

idnumber
namestring
aliasstring
status'OPERATIONAL' | 'UNDER_MAINTENANCE' | 'DEGRADED' | 'PARTIAL_OUTAGE' | 'MAJOR_OUTAGE'

the service status

descriptionstring
oneOpenIncidentOnlyboolean
showUptimeHistoryboolean
subscribedboolean