Status pages

List status pages

GET/v1/status-pages

Each page with its groups and components; use the component id to set its status.

Authorization

apiKey

AuthorizationBearer <token>

Your organization's API key.

In: header

`application/json`

curl -X GET "https://example.com/v1/status-pages"

[  {    "id": "string",    "name": "string",    "slug": "string",    "description": "string",    "visibility": "PUBLIC",    "autoPublishIncidents": true,    "groups": [      {        "id": "string",        "name": "string",        "components": [          {            "id": "string",            "name": "string",            "description": "string",            "monitorIds": [              "string"            ],            "showResponseTimes": true          }        ]      }    ],    "uptimeRangeDays": 30,    "uptimePeriods": [      "24h"    ],    "passwordSet": true,    "draft": {},    "visitorSpikeAlert": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Create a status page

POST/v1/status-pages

Needs a READ_WRITE key from an owner or admin. The page starts without components; set them with PUT /v1/status-pages/{pageId}/layout.

Authorization

apiKey

AuthorizationBearer <token>

Your organization's API key.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Lengthlength <= 100

slug*string

The page's address.

Match^[a-z0-9]+(?:-[a-z0-9]+)*$

Length3 <= length <= 60

description?|

Lengthlength <= 1000

visibility?StatusPageVisibility

PUBLIC (default) or HIDDEN; a page becomes PASSWORD once its password is set in StatusTick.

Value in

"PUBLIC"
"HIDDEN"
"PASSWORD"

`application/json`

curl -X POST "https://example.com/v1/status-pages" \  -H "Content-Type: application/json" \  -d '{    "name": "Acme status",    "slug": "acme",    "visibility": "PUBLIC"  }'

{  "id": "string",  "name": "string",  "slug": "string",  "description": "string",  "visibility": "PUBLIC",  "autoPublishIncidents": true,  "groups": [    {      "id": "string",      "name": "string",      "components": [        {          "id": "string",          "name": "string",          "description": "string",          "monitorIds": [            "string"          ],          "showResponseTimes": true        }      ]    }  ],  "uptimeRangeDays": 30,  "uptimePeriods": [    "24h"  ],  "passwordSet": true,  "draft": {},  "visitorSpikeAlert": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get a status page

GET/v1/status-pages/{pageId}

The published page; unpublished changes made in the editor are in draft.

Authorization

apiKey

AuthorizationBearer <token>

Your organization's API key.

In: header

`application/json`

curl -X GET "https://example.com/v1/status-pages/string"

{  "id": "string",  "name": "string",  "slug": "string",  "description": "string",  "visibility": "PUBLIC",  "autoPublishIncidents": true,  "groups": [    {      "id": "string",      "name": "string",      "components": [        {          "id": "string",          "name": "string",          "description": "string",          "monitorIds": [            "string"          ],          "showResponseTimes": true        }      ]    }  ],  "uptimeRangeDays": 30,  "uptimePeriods": [    "24h"  ],  "passwordSet": true,  "draft": {},  "visitorSpikeAlert": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Change a status page's settings

PATCH/v1/status-pages/{pageId}

Needs a READ_WRITE key from an owner or admin. Applies at once. Leave out the fields you do not change.

Authorization

apiKey

AuthorizationBearer <token>

Your organization's API key.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

slug?string

description?string

visibility?StatusPageVisibility

HIDDEN pages are reachable by their link only; PASSWORD pages ask for the visitors' password.

Value in

"PUBLIC"
"HIDDEN"
"PASSWORD"

autoPublishIncidents?boolean

uptimeRangeDays?integer

Value in

30
60
90

uptimePeriods?array<>

Items1 <= items

visitorSpikeAlert?boolean

Alert on visitor spikes; applies at once, outside the draft.

`application/json`

curl -X PATCH "https://example.com/v1/status-pages/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Acme status",    "description": "Live status of Acme."  }'

{  "id": "string",  "name": "string",  "slug": "string",  "description": "string",  "visibility": "PUBLIC",  "autoPublishIncidents": true,  "groups": [    {      "id": "string",      "name": "string",      "components": [        {          "id": "string",          "name": "string",          "description": "string",          "monitorIds": [            "string"          ],          "showResponseTimes": true        }      ]    }  ],  "uptimeRangeDays": 30,  "uptimePeriods": [    "24h"  ],  "passwordSet": true,  "draft": {},  "visitorSpikeAlert": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Set a status page's groups and components

PUT/v1/status-pages/{pageId}/layout

Needs a READ_WRITE key from an owner or admin. Replaces every group and component of the published page at once. Keep a component's id to keep its status history; a component without an id is new, and one left out is removed. A component shows at most 20 monitors.

Authorization

apiKey

AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

pageId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

groups?array<>

Response Body

`application/json`

curl -X PUT "https://example.com/v1/status-pages/string/layout" \  -H "Content-Type: application/json" \  -d '{    "groups": [      {        "name": "Website",        "components": [          {            "name": "Shop",            "monitorIds": [              "mnt_4KrVK3M1DqhDTFouCffKie"            ]          }        ]      }    ]  }'

{  "id": "string",  "name": "string",  "slug": "string",  "description": "string",  "visibility": "PUBLIC",  "autoPublishIncidents": true,  "groups": [    {      "id": "string",      "name": "string",      "components": [        {          "id": "string",          "name": "string",          "description": "string",          "monitorIds": [            "string"          ],          "showResponseTimes": true        }      ]    }  ],  "uptimeRangeDays": 30,  "uptimePeriods": [    "24h"  ],  "passwordSet": true,  "draft": {},  "visitorSpikeAlert": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get a page's views and unique visitors

GET/v1/status-pages/{pageId}/views

Views counted from the page's beacon, on its StatusTick address and its custom domain; bots are left out. A visitor counts once per page per UTC day, without cookies and without their IP being kept. Hourly points count a visitor in the hour of their first view that day.

Authorization

apiKey

AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

pageId*string

Query Parameters

range?string

24 hourly points, or 7 or 30 daily points (UTC days); the current hour or day is the last.

Default"LAST_24_HOURS"

Value in

"LAST_24_HOURS"
"LAST_7_DAYS"
"LAST_30_DAYS"

Response Body

`application/json`

curl -X GET "https://example.com/v1/status-pages/string/views"

{  "range": "LAST_24_HOURS",  "views": 0,  "uniqueVisitors": 0,  "points": [    {      "at": "2019-08-24T14:15:22Z",      "views": 0,      "uniqueVisitors": 0    }  ]}

List the status of every component

GET/v1/status-pages/{pageId}/component-statuses

Authorization

apiKey

AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

pageId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/status-pages/string/component-statuses"

[  {    "componentId": "string",    "manual": true,    "manualStatus": "OPERATIONAL",    "message": "string",    "status": "OPERATIONAL",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Set the status of a component

PUT/v1/status-pages/{pageId}/components/{componentId}/status

Needs a READ_WRITE key. Only for components without monitors; a component with monitors answers 422 (status_page.component.monitored.unprocessable). The message is shown under the component on the public page; an empty message clears it.

Authorization

apiKey

AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

pageId*string

componentId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status*ComponentStatusValue

Value in

"OPERATIONAL"
"DEGRADED_PERFORMANCE"
"PARTIAL_OUTAGE"
"MAJOR_OUTAGE"
"UNDER_MAINTENANCE"

message?|

Lengthlength <= 500

Response Body

`application/json`

curl -X PUT "https://example.com/v1/status-pages/string/components/string/status" \  -H "Content-Type: application/json" \  -d '{    "status": "MAJOR_OUTAGE",    "message": "Phone support is down."  }'

{  "componentId": "string",  "manual": true,  "manualStatus": "OPERATIONAL",  "message": "string",  "status": "OPERATIONAL",  "updatedAt": "2019-08-24T14:15:22Z"}

List a component's status changes

GET/v1/status-pages/{pageId}/components/{componentId}/status-changes

Authorization

apiKey

AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

pageId*string

componentId*string

Query Parameters

limit?integer

Rangevalue <= 100

Default50

page?integer

Default0

Response Body

`application/json`

curl -X GET "https://example.com/v1/status-pages/string/components/string/status-changes"

{  "changes": [    {      "componentId": "string",      "fromStatus": "OPERATIONAL",      "toStatus": "OPERATIONAL",      "source": "MANUAL",      "actorId": "string",      "actorName": "string",      "message": "string",      "changedAt": "2019-08-24T14:15:22Z"    }  ],  "page": 0,  "limit": 0,  "hasMore": true}

Show a monitor on components

PUT/v1/status-pages/monitors/{monitorId}/components

Needs a READ_WRITE key. The monitor shows on exactly these components (ids from GET /v1/status-pages) and is taken off every other component of your pages; an empty list takes it off all of them. Applies at once, outside any unpublished draft of a page.

Authorization

apiKey

AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

componentIds*array<string>

Response Body

`application/json`

curl -X PUT "https://example.com/v1/status-pages/monitors/mnt_4KrVK3M1DqhDTFouCffKie/components" \  -H "Content-Type: application/json" \  -d '{    "componentIds": [      "spc_2bS9wQm4LxT7nYc1Hd8KpE"    ]  }'

{  "monitorId": "string",  "componentIds": [    "string"  ]}

Status pages

List status pagesCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/json

429application/json

Create a status pageCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

400application/json

403application/json

409application/json

Get a status pageCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

Change a status page's settingsCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

403application/json

404application/json

Delete a status pageCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

204

403application/json

404application/json

Set a status page's groups and componentsCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

403application/json

404application/json

Get a page's views and unique visitorsCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

List the status of every componentCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Set the status of a componentCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

403application/json

422application/json

List a component's status changesCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Show a monitor on componentsCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

403application/json

List status pages

Authorization

Response Body

`application/json`

`application/json`

`application/json`

Create a status page

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Get a status page

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Change a status page's settings

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Delete a status page

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Set a status page's groups and components

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Get a page's views and unique visitors

Authorization

Path Parameters

Query Parameters

Response Body

`application/json`

`application/json`

List the status of every component

Authorization

Path Parameters

Response Body

`application/json`

Set the status of a component

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

List a component's status changes

Authorization

Path Parameters

Query Parameters

Response Body

`application/json`

Show a monitor on components

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`