v1
latestOpenAPI 3.1.02026-08-06360288.3 KBStatus
Status Summary
Retrieve a summary of the current status of all components and containers.
This method returns the same data structure as the public status API endpoint that you can provide to your API consumers. The Public Status API endpoint for your status page is available in the API tab of your Dashboard.
get/status/summary/{statuspage_id}
Path parameters
statuspage_idstring required
ID of the status page
Headers
x-api-idstring required
x-api-keystring required
Response
OK
Example response
{
"result": {
"incidents": [
{
"_id": "59b709b105ae230bc72ec241",
"components_affected": [
{
"_id": "5334ebfae64cf90000000008",
"name": "Database"
}
],
"containers_affected": [
{
"_id": "5332766bf678630000000016",
"name": "Primary Data Center"
}
],
"datetime_open": "2015-06-28T17:14:44.798Z",
"messages": [
{
"datetime": "2015-06-28T17:14:44.798Z",
"details": "We are investigating database errors affecting our primary data center. Some users may experience intermittent service disruptions.",
"state": 100,
"status": 500
},
{
"datetime": "2015-06-28T17:16:44.798Z",
"details": "The root cause has been identified and a temporary fix has been applied. We are monitoring the situation closely to ensure stability.",
"state": 200,
"status": 300
}
],
"name": "Database Connection Issues"
}
],
"maintenance": {
"active": [],
"upcoming": [
{
"_id": "5a597a34095336047fd1f874",
"components_affected": [
{
"_id": "5332766bf678630000000017",
"name": "Website"
}
],
"containers_affected": [
{
"_id": "5332766bf678630000000016",
"name": "Primary Data Center"
}
],
"datetime_open": "2015-04-02T03:17:08.971Z",
"datetime_planned_end": "2015-09-26T23:00:00.000Z",
"datetime_planned_start": "2015-09-26T22:00:00.000Z",
"messages": [
{
"datetime": "2015-04-02T03:17:08.971Z",
"details": "Scheduled maintenance has been planned to increase memory capacity for web servers. This upgrade will improve performance and reliability.",
"state": 100,
"status": 200
}
],
"name": "Web Server Hardware Upgrade"
}
]
},
"status": [
{
"containers": [
{
"id": "5334ebefe64cf90000000007",
"name": "DC 3",
"status": "Partial Service Disruption",
"status_code": 400,
"updated": "2015-06-28T17:16:44.798Z"
},
{
"id": "5332766bf678630000000016",
"name": "Primary Data Center",
"status": "Security Event",
"status_code": 600,
"updated": "2015-06-28T17:16:44.798Z"
}
],
"id": "5334ebfae64cf90000000008",
"name": "Database",
"status": "Security Event",
"status_code": 600,
"updated": "2015-06-28T17:16:44.798Z"
},
{
"containers": [
{
"id": "5332766bf678630000000016",
"name": "Primary Data Center",
"status": "Operational",
"status_code": 100,
"updated": "2015-06-28T17:16:44.798Z"
}
],
"id": "5332766bf678630000000017",
"name": "Website",
"status": "Operational",
"status_code": 100,
"updated": "2015-06-28T17:16:44.798Z"
}
],
"status_overall": {
"status": "Security Event",
"status_code": 600,
"updated": "2015-06-28T17:16:44.798Z"
}
},
"status": {
"error": "no",
"message": "Get public api status successfully"
}
}