SPspectate
Status pages

List status pages

Returns the team's status pages, by name unless you sort.

get/status-pages

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, from 1.

per_pageinteger

Status pages per page, 1 to 100.

filter[visibility]'public' | 'private'

Who can open a status page.

public <br/> Anyone.
private <br/> Visitors with the access link, or the password when the page has one. Part of the Team plan and up.

Only pages with this visibility.

filter[search]string

Case-insensitive text in the name, slug or custom domain.

sortstring

Sort by name or created_at. Prefix - for descending. Default name.

Response

Paginated set of StatusPage

current_pageinteger required
first_page_urlstring nullable required
frominteger nullable required
last_page_urlstring nullable required
last_pageinteger required
next_page_urlstring nullable required
pathstring nullable required

Base path for paginator generated URLs.

per_pageinteger required

Number of items shown per page.

prev_page_urlstring nullable required
tointeger nullable required

Number of the last item in the slice.

totalinteger required

Total number of items being paginated.

Example response

{
  "data": [
    {
      "name": "Acme status",
      "slug": "acme",
      "public_url": "https://acme.spectate.page",
      "custom_domain": "status.acme.com",
      "custom_domain_verification": {
        "txt_record_name": "_spectate.status.example.com",
        "txt_record_value": "spectate-verify=4f1c0c2e9b7a4d3f8e6a5b2c1d0e9f8a",
        "cname_target": "4f1c0c2e9b7a4d3f.custom.spectate.page"
      },
      "logo_link_url": "https://acme.com",
      "contact_url": "mailto:support@acme.com",
      "theme": {
        "accent": "#0f766e",
        "light": {
          "background": "#ffffff",
          "surface": "#f8fafc",
          "foreground": "#0f172a",
          "muted": "#64748b",
          "border": "#e2e8f0",
          "success": "#16a34a",
          "warning": "#ca8a04",
          "partial": "#ea580c",
          "danger": "#dc2626",
          "info": "#2563eb"
        },
        "dark": {
          "background": "#ffffff",
          "surface": "#f8fafc",
          "foreground": "#0f172a",
          "muted": "#64748b",
          "border": "#e2e8f0",
          "success": "#16a34a",
          "warning": "#ca8a04",
          "partial": "#ea580c",
          "danger": "#dc2626",
          "info": "#2563eb"
        }
      },
      "automation_down_message": "We're looking into problems with {component}.",
      "automation_recovered_message": "{component} is working again.",
      "escalation_paths": [
        {
          "name": "On-call engineers"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.