GET/v2/statuspages/{uuid}

Get a status page

Returns a specific status page with full configuration details.

Request

Path Parameters

uuidstringrequired

The status page UUID

Example:"sp_abc123xyz"

Response

Returns the status page with all settings and sections.

Sections

Each service carries a read-only type: monitor, healthcheck, server or component. Its id and uuid are the same identifier (mon_, hc_, agt_ or comp_). A group (is_group: true) has no identifier, and its services are listed in services. Names and descriptions are objects keyed by language.

show_when_all_up (a summary row that disappears when a hidden service goes down) is set in the dashboard. The API does not write it, so a PUT with sections resets it to false.

💡Changing sections

A PUT replaces all the sections, so start from this response: change what you need and send every section back. Sending it back unchanged changes nothing, type included. See Update a status page.

RequestcURL

curl -X GET https://api.hyperping.io/v2/statuspages/sp_abc123xyz \
  -H "Authorization: Bearer ${API_TOKEN}"

200 OKJSON

{
  "statuspage": {
    "uuid": "sp_abc123xyz",
    "name": "My Status Page",
    "hostname": "status.mycompany.com",
    "hostedsubdomain": "mycompany.hyperping.app",
    "url": "status.mycompany.com",
    "password_protected": false,
    "settings": {
      "name": "My Status Page",
      "website": "https://mycompany.com",
      "description": {
        "en": "Service status for My Company"
      },
      "languages": [
        "en"
      ],
      "default_language": "en",
      "theme": "system",
      "font": "Inter",
      "accent_color": "#36b27e",
      "auto_refresh": false,
      "banner_header": true,
      "logo": "https://example.com/logo.png",
      "logo_height": "32px",
      "favicon": "https://example.com/favicon.ico",
      "hide_powered_by": false,
      "hide_from_search_engines": false,
      "google_analytics": null,
      "subscribe": {
        "enabled": true,
        "email": true,
        "slack": true,
        "teams": false,
        "sms": false
      },
      "authentication": {
        "password_protection": false,
        "google_sso": true,
        "google_allowed_domains": [
          "mycompany.com"
        ],
        "saml_sso": true,
        "sso_connection_uuid": "sso_abc123xyz",
        "sso_connection": {
          "uuid": "sso_abc123xyz",
          "name": "Corporate Azure AD",
          "provider": "azure"
        }
      }
    },
    "sections": [
      {
        "name": {
          "en": "API"
        },
        "is_split": true,
        "services": [
          {
            "id": "mon_OYKr5fpSDHqbP2",
            "uuid": "mon_OYKr5fpSDHqbP2",
            "type": "monitor",
            "name": {
              "en": "Public API"
            },
            "description": {
              "en": "REST API and webhooks"
            },
            "is_group": false,
            "show_uptime": true,
            "show_response_times": true,
            "hide_when_up": false,
            "show_when_all_up": false
          },
          {
            "id": "hc_kTnB3x9LqWm2Vd8RcY4sPa1Z",
            "uuid": "hc_kTnB3x9LqWm2Vd8RcY4sPa1Z",
            "type": "healthcheck",
            "name": {
              "en": "Nightly backup"
            },
            "is_group": false,
            "show_uptime": true,
            "show_response_times": false,
            "hide_when_up": false,
            "show_when_all_up": false
          }
        ]
      },
      {
        "name": {
          "en": "Infrastructure"
        },
        "is_split": true,
        "services": [
          {
            "name": {
              "en": "Database cluster"
            },
            "is_group": true,
            "show_uptime": true,
            "show_response_times": true,
            "hide_when_up": false,
            "show_when_all_up": false,
            "services": [
              {
                "id": "mon_Db7PrimaryX9k2L",
                "uuid": "mon_Db7PrimaryX9k2L",
                "type": "monitor",
                "name": {
                  "en": "Primary"
                },
                "show_uptime": true,
                "show_response_times": true,
                "hide_when_up": false
              },
              {
                "id": "hc_Rp7ReplicaSyncQw3Ez5Tb",
                "uuid": "hc_Rp7ReplicaSyncQw3Ez5Tb",
                "type": "healthcheck",
                "name": {
                  "en": "Replica sync"
                },
                "show_uptime": true,
                "show_response_times": false,
                "hide_when_up": false
              }
            ]
          }
        ]
      }
    ]
  }
}

← List status pages Create a status page →