v1

latestOpenAPI 3.1.02026-08-06360288.3 KB
Components

List Components

List all components and their associated containers for a status page.

get/component/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": [
    {
      "__v": 0,
      "_id": "53d75690483cd492cf000008",
      "containers": [
        {
          "__v": 0,
          "_id": "52e5e0e08935485437000019",
          "location": "do-ams-2",
          "name": "Amsterdam"
        }
      ],
      "name": "Database",
      "position": 2,
      "statuspage": "53d74690383cd493cf000008"
    },
    {
      "__v": 0,
      "_id": "52e5e0e0893548543700001a",
      "containers": [
        {
          "__v": 0,
          "_id": "52e5e0e08935485437000019",
          "location": "do-ams-2",
          "name": "Amsterdam"
        },
        {
          "__v": 0,
          "_id": "52e5e2d6b799555038000009",
          "location": "ap-northeast-1",
          "name": "Tokyo"
        }
      ],
      "name": "Website",
      "position": 1,
      "statuspage": "53d74690383cd493cf000008"
    }
  ],
  "status": {
    "error": "no",
    "message": "OK"
  }
}
All 36 operations