v1

latestOpenAPI 3.1.02026-08-06360288.3 KB
Maintenance

List Maintenance (Deprecated)

DEPRECATED

Retrieve all active, resolved, and upcoming maintenance events. Limited to 100 results.

Warning: This method will be removed in future versions. Use the maintenance/list/pending, maintenance/list/active and maintenance/list/closed methods instead.

get/maintenance/list/{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": {
    "active_maintenances": [],
    "resolved_maintenances": [],
    "upcoming_maintenances": [
      {
        "__v": 0,
        "_id": "52e5eacc908cdc5e39000009",
        "components_affected": [
          {
            "__v": 0,
            "_id": "52e5e0e0893548543700001a",
            "containers": [
              "52e5e0e08935485437000019",
              "52e5e2d6b799555038000009"
            ],
            "name": "Website",
            "position": 1,
            "statuspage": "52e5e0e0893548543700000b"
          }
        ],
        "containers_affected": [
          {
            "__v": 0,
            "_id": "52e5e0e08935485437000019",
            "location": "do-ams-2",
            "name": "Amsterdam"
          }
        ],
        "datetime_open": "2014-01-27T05:12:44.880Z",
        "datetime_planned_end": "2013-12-30T12:00:00.000Z",
        "datetime_planned_start": "2014-01-05T12:00:00.000Z",
        "infrastructure_affected": [
          {
            "_id": "5a1b41edb4546d046c8efa06",
            "component": {
              "__v": 0,
              "_id": "52e5e0e0893548543700001a",
              "containers": [
                "52e5e0e08935485437000019",
                "52e5e2d6b799555038000009"
              ],
              "name": "Website",
              "position": 1,
              "statuspage": "52e5e0e0893548543700000b"
            },
            "container": {
              "__v": 0,
              "_id": "52e5e0e08935485437000019",
              "location": "do-ams-2",
              "location_geo": {
                "coords": []
              },
              "name": "Amsterdam",
              "position": 1
            }
          }
        ],
        "kind": "maintenance",
        "messages": [
          {
            "components": [
              "52e5e0e0893548543700001a"
            ],
            "__v": 0,
            "_id": "52e5eacc908cdc5e3900000a",
            "containers": [
              "52e5e0e08935485437000019"
            ],
            "datetime": "2014-01-27T05:12:44.937Z",
            "details": "Scheduled maintenance has been planned for the Website component in the Amsterdam data center. This maintenance is expected to improve system performance and reliability.",
            "ip": "203.0.113.42",
            "maintenance": "52e5eacc908cdc5e39000009",
            "source": "Dashboard",
            "state": 100,
            "status": 200,
            "statuspage": "52e5e0e0893548543700000b"
          }
        ],
        "name": "Scheduled Database Maintenance",
        "statuspage": "52e5e0e0893548543700000b"
      }
    ]
  },
  "status": {
    "error": "no",
    "message": "OK"
  }
}