This is the API version of your status page. Because robots care about your status too!

The Public Status API enables you to provide your API consumers with a simple GET request to query the current status.

Requirements

Status page must be activated and in public mode to use the Public Status API.

 

Example Response (JSON)

{ "result": 
  { "status_overall": 
    { "updated": "2016-01-29T22:57:03.079Z", 
      "status": "Operational", 
      "status_code": 100     
    }, 
    "status": [ 
      { "id": "56a807c7b62d59d808000010", 
        "name": "Website", 
        "updated": "2016-01-29T22:57:03.079Z", 
        "status": "Operational", 
        "status_code": 100, 
        "containers": [ 
          { "id": "56a807c7b62d59d808000012", 
            "name": "US-West", 
            "updated": "2016-01-29T22:55:53.004Z", 
            "status": "Operational", 
            "status_code": 100 
          }, 
          { "id": "56a807c7b62d59d808000013", 
            "name": "US-East", 
            "updated": "2016-01-29T22:55:53.004Z", 
            "status": "Operational", 
            "status_code": 100 
          } 
        ] 
      } 
    ], 
    "incidents": [], 
    "maintenance": { 
      "active": [], 
      "upcoming": [] 
    } 
  } 
}

Detailed Example Response (JSON)

Includes active incidents, active maintenances and scheduled maintenances.

{
    "result": {
        "status_overall": {
            "updated": "2021-12-06T16:49:49.455Z",
            "status": "Planned Maintenance",
            "status_code": 200
        },
        "status": [
            {
                "id": "5a89ef6740eba40d1c3bb4a8",
                "name": "Website",
                "updated": "2021-12-06T16:49:49.455Z",
                "status": "Planned Maintenance",
                "status_code": 200,
                "containers": [
                    {
                        "id": "5a89ef6740eba40d1c3bb4a7",
                        "name": "Virginia",
                        "updated": "2021-12-06T16:49:03.891Z",
                        "status": "Planned Maintenance",
                        "status_code": 200
                    }
                ]
            },
            {
                "id": "61ae3d57e3e33c05d23d5249",
                "name": "Mobile App",
                "updated": "2021-12-06T16:49:49.455Z",
                "status": "Planned Maintenance",
                "status_code": 200,
                "containers": [
                    {
                        "id": "5a89ef6740eba40d1c3bb4a7",
                        "name": "Virginia",
                        "updated": "2021-12-06T16:49:03.890Z",
                        "status": "Planned Maintenance",
                        "status_code": 200
                    },
                    {
                        "id": "61ae3d3da163f805d867f0b5",
                        "name": "Ireland",
                        "updated": "2021-12-06T16:49:03.887Z",
                        "status": "Planned Maintenance",
                        "status_code": 200
                    }
                ]
            }
        ],
        "incidents": [
            {
                "name": "Authentication Issues",
                "_id": "61ae3daa9c768905d9f0f6fd",
                "datetime_open": "2021-12-06T16:43:22.431Z",
                "messages": [
                    {
                        "details": "Investigating authentication errors.",
                        "state": 100,
                        "status": 300,
                        "datetime": "2021-12-06T16:43:22.457Z"
                    },
                    {
                        "details": "The issue has been identified.",
                        "state": 200,
                        "status": 300,
                        "datetime": "2021-12-06T16:45:19.810Z"
                    }
                ],
                "containers_affected": [
                    {
                        "name": "Virginia",
                        "_id": "5a89ef6740eba40d1c3bb4a7"
                    },
                    {
                        "name": "Ireland",
                        "_id": "61ae3d3da163f805d867f0b5"
                    }
                ],
                "components_affected": [
                    {
                        "name": "Mobile App",
                        "_id": "61ae3d57e3e33c05d23d5249"
                    }
                ]
            }
        ],
        "maintenance": {
            "active": [
                {
                    "name": "Network Upgrade",
                    "_id": "61ae3ef0a163f805d867f0b6",
                    "datetime_open": "2021-12-06T16:48:48.491Z",
                    "datetime_planned_start": "2021-12-06T16:50:00.000Z",
                    "datetime_planned_end": "2021-12-06T17:50:00.000Z",
                    "messages": [
                        {
                            "details": "Network upgrades will be performed during this maintenance. No downtime is expected.",
                            "state": 100,
                            "status": 200,
                            "datetime": "2021-12-06T16:48:48.508Z"
                        },
                        {
                            "details": "Starting maintenance now.",
                            "state": 200,
                            "status": 200,
                            "datetime": "2021-12-06T16:49:03.798Z"
                        },
                        {
                            "details": "Upgrades are still in progress.",
                            "state": 200,
                            "status": 200,
                            "datetime": "2021-12-06T16:49:16.659Z"
                        }
                    ],
                    "containers_affected": [
                        {
                            "name": "Virginia",
                            "_id": "5a89ef6740eba40d1c3bb4a7"
                        },
                        {
                            "name": "Ireland",
                            "_id": "61ae3d3da163f805d867f0b5"
                        }
                    ],
                    "components_affected": [
                        {
                            "name": "Website",
                            "_id": "5a89ef6740eba40d1c3bb4a8"
                        },
                        {
                            "name": "Mobile App",
                            "_id": "61ae3d57e3e33c05d23d5249"
                        }
                    ]
                }
            ],
            "upcoming": [
                {
                    "name": "Mobile App Upgrade",
                    "_id": "61ae3e9ee3e33c05d23d524f",
                    "datetime_open": "2021-12-06T16:47:26.677Z",
                    "datetime_planned_start": "2021-12-22T15:00:00.000Z",
                    "datetime_planned_end": "2021-12-22T15:15:00.000Z",
                    "messages": [
                        {
                            "details": "The mobile app will be upgraded.",
                            "state": 100,
                            "status": 200,
                            "datetime": "2021-12-06T16:47:26.695Z"
                        }
                    ],
                    "containers_affected": [
                        {
                            "name": "Virginia",
                            "_id": "5a89ef6740eba40d1c3bb4a7"
                        },
                        {
                            "name": "Ireland",
                            "_id": "61ae3d3da163f805d867f0b5"
                        }
                    ],
                    "components_affected": [
                        {
                            "name": "Mobile App",
                            "_id": "61ae3d57e3e33c05d23d5249"
                        }
                    ]
                },
                {
                    "name": "Server Upgrade",
                    "_id": "61ae3e78e3e33c05d23d524c",
                    "datetime_open": "2021-12-06T16:46:48.074Z",
                    "datetime_planned_start": "2021-12-20T16:30:00.000Z",
                    "datetime_planned_end": "2021-12-20T16:45:00.000Z",
                    "messages": [
                        {
                            "details": "The web server will be upgraded. No downtime is expected during this maintenance.",
                            "state": 100,
                            "status": 200,
                            "datetime": "2021-12-06T16:46:48.173Z"
                        }
                    ],
                    "containers_affected": [
                        {
                            "name": "Virginia",
                            "_id": "5a89ef6740eba40d1c3bb4a7"
                        }
                    ],
                    "components_affected": [
                        {
                            "name": "Website",
                            "_id": "5a89ef6740eba40d1c3bb4a8"
                        }
                    ]
                }
            ]
        }
    }
}