Skip to main content
GET
Get a status page by id or key, with its metrics in display order

Authorizations

Authorization
string
header
required

An organization API key (obs_pub_…) sent as Authorization: Bearer <key>. Each key carries scopes; an endpoint lists the scope it needs. read:change_events is reserved: keys can carry it, but no endpoint needs it yet.

Scopes

read:config

Path Parameters

id
string
required

The page's id, or its key in config documents (its config_key, or the key config export gives one made in the console).

Response

ok

id
string<uuid>
required
title
string
required
subdomain
string
required
public_url
string<uri>
required

Where the page is served: the custom domain when it is active, else the subdomain URL.

access_mode
string
required

public, password, sso, ip_allowlist, jwt or customer_scoped.

layout
string
timezone
string
locale
string
allow_subscriptions
boolean
show_auto_refresh
boolean
hide_branding
boolean

The operator's choice; the footer link is hidden only on a plan that includes branding removal.

metric_group_order
(string | null)[] | null
metric_group_summary
boolean
seo_description
string | null
seo_noindex
boolean
custom_domain
object | null

The custom domain, when one is set up (in the console).

config_key
string | null

The page's key in config documents (null for one made in the console and never applied from config). Per-key DELETE takes this.

managed_by
enum<string>

config: owned by config apply (prune and per-key delete may remove it). console: made in the console; config apply adopts it when a document names it.

Available options:
config,
console
is_demo
boolean
updated_at
string<date-time>
suspended
boolean

true while the status page is suspended because the organization is over its plan's limit (after a 7-day grace). Nothing is deleted; it is read-only until the person chooses it as active in Billing or upgrades. Writes return 403 item_suspended_plan.

suspended_at
string<date-time> | null

When the suspension started.

metrics
object[]

The page's metrics in display order. public_label and show_uptime are console settings that config apply keeps.

key
string

The page's key in config documents: its config_key, or the key config export gives a console page. PUT /pages/{key} takes it.