Skip to main content
GET
Get a status page, 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.

Path Parameters

id
string<uuid>
required

Page id.

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, ip_allowlist, jwt or customer_scoped.

layout
string
timezone
string
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>
metrics
object[]

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