Status Pages
an integer specifying the starting point (beginning with 0) when paging through a list of entities
0
the maximum number of results when paging through a list of status pages.
25
GET /api/status-pages HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
The status pages
[
{
"id": 1,
"name": "text",
"domain": "text",
"subdomain": "text",
"timezone": "Europe/Berlin",
"faviconUrl": "text",
"logoUrl": "text",
"visibility": "PRIVATE",
"hiddenFromSearch": true,
"showSubscribeAction": true,
"showIncidentHistoryOption": true,
"pageTitle": "text",
"pageDescription": "text",
"logoRedirectUrl": "text",
"activated": true,
"status": "OPERATIONAL",
"teams": [
{
"id": 1,
"name": "text"
}
],
"services": [
{
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
],
"uptime": {
"rangeStart": "2025-07-08T10:04:13.175Z",
"rangeEnd": "2025-07-08T10:04:13.175Z",
"outages": [
{
"status": "OPERATIONAL",
"from": "2025-07-08T10:04:13.175Z",
"until": "2025-07-08T10:04:13.175Z"
}
],
"uptimePercentage": {
"uptimePercentage": {
"p90": 1,
"p60": 1,
"p30": 1
}
}
}
}
],
"metrics": [
{
"id": 1,
"name": "text",
"description": "text",
"aggregationType": "AVG",
"displayType": "GRAPH",
"interpolateGaps": false,
"lockYAxisMax": 1,
"lockYAxisMin": 1,
"mouseOverDecimal": 1,
"showValuesOnMouseOver": false,
"unitLabel": "text",
"teams": [
{
"id": 1,
"name": "text"
}
]
}
],
"ipWhitelist": [
"text"
],
"subscribed": true,
"announcement": "text",
"announcementOnPage": true,
"announcementInWidget": true,
"audienceSpecific": false
}
]
the service status
ipv4 or ipv6 addresses to give access to. Can only be set on 'PRIVATE' status pages
POST /api/status-pages HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1035
{
"id": 1,
"name": "text",
"domain": "text",
"subdomain": "text",
"timezone": "Europe/Berlin",
"faviconUrl": "text",
"logoUrl": "text",
"visibility": "PRIVATE",
"hiddenFromSearch": true,
"showSubscribeAction": true,
"showIncidentHistoryOption": true,
"pageTitle": "text",
"pageDescription": "text",
"pageLayout": "SINGLE_COLUMN",
"logoRedirectUrl": "text",
"activated": true,
"status": "OPERATIONAL",
"teams": [
{
"id": 1,
"name": "text"
}
],
"services": [
{
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
}
],
"metrics": [
{
"id": 1,
"name": "text",
"description": "text",
"aggregationType": "AVG",
"displayType": "GRAPH",
"interpolateGaps": false,
"lockYAxisMax": 1,
"lockYAxisMin": 1,
"mouseOverDecimal": 1,
"showValuesOnMouseOver": false,
"unitLabel": "text",
"teams": [
{
"id": 1,
"name": "text"
}
]
}
],
"ipWhitelist": [
"text"
],
"structure": {
"elements": [
{
"id": 1,
"type": "SERVICE",
"options": "expand",
"children": [
{
"id": 1,
"type": "SERVICE",
"options": "expand",
"children": "[Circular Reference]"
}
]
}
]
},
"appearance": "LIGHT"
}
The newly created status page
{
"id": 1,
"name": "text",
"domain": "text",
"subdomain": "text",
"timezone": "Europe/Berlin",
"faviconUrl": "text",
"logoUrl": "text",
"visibility": "PRIVATE",
"hiddenFromSearch": true,
"showSubscribeAction": true,
"showIncidentHistoryOption": true,
"pageTitle": "text",
"pageDescription": "text",
"pageLayout": "SINGLE_COLUMN",
"logoRedirectUrl": "text",
"activated": true,
"status": "OPERATIONAL",
"teams": [
{
"id": 1,
"name": "text"
}
],
"services": [
{
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
}
],
"metrics": [
{
"id": 1,
"name": "text",
"description": "text",
"aggregationType": "AVG",
"displayType": "GRAPH",
"interpolateGaps": false,
"lockYAxisMax": 1,
"lockYAxisMin": 1,
"mouseOverDecimal": 1,
"showValuesOnMouseOver": false,
"unitLabel": "text",
"teams": [
{
"id": 1,
"name": "text"
}
]
}
],
"ipWhitelist": [
"text"
],
"structure": {
"elements": [
{
"id": 1,
"type": "SERVICE",
"options": "expand",
"children": [
{
"id": 1,
"type": "SERVICE",
"options": "expand",
"children": "[Circular Reference]"
}
]
}
]
},
"appearance": "LIGHT"
}
entity ID
GET /api/status-pages/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
The requested status page
{
"id": 1,
"name": "text",
"domain": "text",
"subdomain": "text",
"timezone": "Europe/Berlin",
"faviconUrl": "text",
"logoUrl": "text",
"visibility": "PRIVATE",
"hiddenFromSearch": true,
"showSubscribeAction": true,
"showIncidentHistoryOption": true,
"pageTitle": "text",
"pageDescription": "text",
"pageLayout": "SINGLE_COLUMN",
"logoRedirectUrl": "text",
"activated": true,
"status": "OPERATIONAL",
"teams": [
{
"id": 1,
"name": "text"
}
],
"services": [
{
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
],
"uptime": {
"rangeStart": "2025-07-08T10:04:13.175Z",
"rangeEnd": "2025-07-08T10:04:13.175Z",
"outages": [
{
"status": "OPERATIONAL",
"from": "2025-07-08T10:04:13.175Z",
"until": "2025-07-08T10:04:13.175Z"
}
],
"uptimePercentage": {
"uptimePercentage": {
"p90": 1,
"p60": 1,
"p30": 1
}
}
}
}
],
"metrics": [
{
"id": 1,
"name": "text",
"description": "text",
"aggregationType": "AVG",
"displayType": "GRAPH",
"interpolateGaps": false,
"lockYAxisMax": 1,
"lockYAxisMin": 1,
"mouseOverDecimal": 1,
"showValuesOnMouseOver": false,
"unitLabel": "text",
"teams": [
{
"id": 1,
"name": "text"
}
]
}
],
"ipWhitelist": [
"text"
],
"structure": {
"elements": [
{
"id": 1,
"type": "SERVICE",
"options": "expand",
"children": [
{
"id": 1,
"type": "SERVICE",
"options": "expand",
"children": "[Circular Reference]"
}
]
}
]
},
"subscribed": true,
"groups": [
{
"id": 1,
"name": "text"
}
],
"appearance": "LIGHT",
"announcement": "text",
"announcementOnPage": true,
"announcementInWidget": true,
"audienceSpecific": false
}
entity ID
the service status
ipv4 or ipv6 addresses to give access to. Can only be set on 'PRIVATE' status pages
PUT /api/status-pages/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1035
{
"id": 1,
"name": "text",
"domain": "text",
"subdomain": "text",
"timezone": "Europe/Berlin",
"faviconUrl": "text",
"logoUrl": "text",
"visibility": "PRIVATE",
"hiddenFromSearch": true,
"showSubscribeAction": true,
"showIncidentHistoryOption": true,
"pageTitle": "text",
"pageDescription": "text",
"pageLayout": "SINGLE_COLUMN",
"logoRedirectUrl": "text",
"activated": true,
"status": "OPERATIONAL",
"teams": [
{
"id": 1,
"name": "text"
}
],
"services": [
{
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
}
],
"metrics": [
{
"id": 1,
"name": "text",
"description": "text",
"aggregationType": "AVG",
"displayType": "GRAPH",
"interpolateGaps": false,
"lockYAxisMax": 1,
"lockYAxisMin": 1,
"mouseOverDecimal": 1,
"showValuesOnMouseOver": false,
"unitLabel": "text",
"teams": [
{
"id": 1,
"name": "text"
}
]
}
],
"ipWhitelist": [
"text"
],
"structure": {
"elements": [
{
"id": 1,
"type": "SERVICE",
"options": "expand",
"children": [
{
"id": 1,
"type": "SERVICE",
"options": "expand",
"children": "[Circular Reference]"
}
]
}
]
},
"appearance": "LIGHT"
}
The updated status page
{
"id": 1,
"name": "text",
"domain": "text",
"subdomain": "text",
"timezone": "Europe/Berlin",
"faviconUrl": "text",
"logoUrl": "text",
"visibility": "PRIVATE",
"hiddenFromSearch": true,
"showSubscribeAction": true,
"showIncidentHistoryOption": true,
"pageTitle": "text",
"pageDescription": "text",
"pageLayout": "SINGLE_COLUMN",
"logoRedirectUrl": "text",
"activated": true,
"status": "OPERATIONAL",
"teams": [
{
"id": 1,
"name": "text"
}
],
"services": [
{
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
}
],
"metrics": [
{
"id": 1,
"name": "text",
"description": "text",
"aggregationType": "AVG",
"displayType": "GRAPH",
"interpolateGaps": false,
"lockYAxisMax": 1,
"lockYAxisMin": 1,
"mouseOverDecimal": 1,
"showValuesOnMouseOver": false,
"unitLabel": "text",
"teams": [
{
"id": 1,
"name": "text"
}
]
}
],
"ipWhitelist": [
"text"
],
"structure": {
"elements": [
{
"id": 1,
"type": "SERVICE",
"options": "expand",
"children": [
{
"id": 1,
"type": "SERVICE",
"options": "expand",
"children": "[Circular Reference]"
}
]
}
]
},
"appearance": "LIGHT"
}
entity ID
an integer specifying the starting point (beginning with 0) when paging through a list of entities
0
the maximum number of results when paging through a list of entities.
50
GET /api/status-pages/{id}/groups HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
The groups of the status page
[
{
"id": 1,
"name": "text"
}
]
entity ID
POST /api/status-pages/{id}/groups HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"id": 1,
"name": "text"
}
The created group
{
"id": 1,
"name": "text"
}
entity ID
entity ID
GET /api/status-pages/{id}/groups/{group-id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": 1,
"name": "text"
}
entity ID
entity ID
PUT /api/status-pages/{id}/groups/{group-id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"id": 1,
"name": "text"
}
The updated group of the status page
{
"id": 1,
"name": "text"
}
entity ID
GET /api/status-pages/{id}/private-subscribers HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
The subscribers of the status page
[
{
"id": 1,
"name": "text",
"type": "USER"
}
]
entity ID
POST /api/status-pages/{id}/private-subscribers HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"id": 1,
"name": "text",
"type": "USER"
}
the response
No content
Note: this is an in place update
entity ID
PUT /api/status-pages/{id}/private-subscribers HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38
[
{
"id": 1,
"name": "text",
"type": "USER"
}
]
the response
No content
entity ID
entity ID
the type of subscriber USER or TEAM
DELETE /api/status-pages/{id}/private-subscribers/{subscriber-id}?subscriber-type=USER HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
the response
No content
Was this helpful?