Status

Status endpoints

Get the status reported on a status page

get

/status_pages/{subdomain}/status

Path parameters

subdomainstringRequired

The subdomain of your status page.

You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).

Responses

200

A status page's status

application/json

Represents the status summary of a status page

403

You lack the necessary permissions to access this resource.

application/json

404

A resource with the provided ID was not found.

application/json

500

Unexpected error.

application/json

get/status_pages/{subdomain}/status

GET /api/v2/status_pages/{subdomain}/status HTTP/1.1
Host: statuspal.io
Accept: */*

{
  "status_page": {
    "url": "google.com",
    "time_zone": "Etc/UTC",
    "subdomain": "google",
    "name": "Google",
    "current_incident_type": "major"
  }
}

Get the status reported on a status page service

get

/status_pages/{subdomain}/services/{serviceId}/status

Path parameters

subdomainstringRequired

The subdomain of your status page.

You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).

serviceIdintegerRequired

The ID of a service

Responses

200

A service's status

application/json

403

You lack the necessary permissions to access this resource.

application/json

404

A resource with the provided ID was not found.

application/json

500

Unexpected error.

application/json

get/status_pages/{subdomain}/services/{serviceId}/status

GET /api/v2/status_pages/{subdomain}/services/{serviceId}/status HTTP/1.1
Host: statuspal.io
Accept: */*

{
  "service": {
    "name": "Monitoring service",
    "id": 1,
    "current_incident_type": "major",
    "children": [
      {
        "name": "Monitoring service",
        "id": 1,
        "current_incident_type": "major",
        "children": [
          {
            "name": "Monitoring service",
            "id": 1,
            "current_incident_type": "major",
            "children": "[Circular Reference]"
          }
        ]
      }
    ]
  }
}