Show

Show the structure of a status page.

This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.

GET /v2/status_page_structures/{status_page_id}

Show

cURL

curl --request GET \
  --url https://api.incident.io/v2/status_page_structures/{status_page_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "current_structure": {
    "items": [
      {
        "component": {
          "component_id": "01FCNDV6P870EA6S7TK1DSYDG1",
          "name": "App"
        },
        "group": {
          "components": [
            {
              "component_id": "01FCNDV6P870EA6S7TK1DSYDG1",
              "name": "App"
            }
          ],
          "id": "01FCNDV6P870EA6S7TK1DSYDG1",
          "name": "EU Data center"
        },
        "sub_page": {
          "id": "01FCNDV6P870EA6S7TK1DSYDG1",
          "items": [
            {
              "component": {
                "component_id": "01FCNDV6P870EA6S7TK1DSYDG1",
                "name": "App"
              },
              "group": {
                "components": [
                  {
                    "component_id": "01FCNDV6P870EA6S7TK1DSYDG1",
                    "name": "App"
                  }
                ],
                "id": "01FCNDV6P870EA6S7TK1DSYDG1",
                "name": "EU Data center"
              }
            }
          ],
          "name": "United Kingdom"
        }
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

API key from your incident.io dashboard (Settings → API keys)

Path Parameters

status_page_id · string · required

ID of the status page

Example:

"abc123"

Response

200 - application/json

OK response.

current_structure · object · required

Show child attributes

Example:

{
  "items": [
    {
      "component": {
        "component_id": "01FCNDV6P870EA6S7TK1DSYDG1",
        "name": "App"
      },
      "group": {
        "components": [
          {
            "component_id": "01FCNDV6P870EA6S7TK1DSYDG1",
            "name": "App"
          }
        ],
        "id": "01FCNDV6P870EA6S7TK1DSYDG1",
        "name": "EU Data center"
      },
      "sub_page": {
        "id": "01FCNDV6P870EA6S7TK1DSYDG1",
        "items": [
          {
            "component": {
              "component_id": "01FCNDV6P870EA6S7TK1DSYDG1",
              "name": "App"
            },
            "group": {
              "components": [
                {
                  "component_id": "01FCNDV6P870EA6S7TK1DSYDG1",
                  "name": "App"
                }
              ],
              "id": "01FCNDV6P870EA6S7TK1DSYDG1",
              "name": "EU Data center"
            }
          }
        ],
        "name": "United Kingdom"
      }
    }
  ]
}