Status pages

Change a status page's settings

Changes only the fields sent; the rest keep their value. Works on any page of the organization, made in the console or by config apply (a config document that names the setting later sets it again). Not settable here: custom CSS, custom domains, and the access modes that carry credentials or allow-lists (password, IP allow-list, JWT, customer-scoped, SSO), which are set in the console. access_mode: public makes a protected page public and removes its access settings. hide_branding: true needs a plan that includes branding removal. theme.preset applies a theme preset and replaces the page’s theme. The response is the page as GET /pages/ returns it, plus changed: the settings that changed.

PATCH

pages

{id}

curl --request PATCH \
  --url https://use.observer/api/v1/pages/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://use.observer/api/v1/pages/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://use.observer/api/v1/pages/{id}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "subdomain": "<string>",
  "public_url": "<string>",
  "access_mode": "<string>",
  "layout": "<string>",
  "timezone": "<string>",
  "locale": "<string>",
  "allow_subscriptions": true,
  "show_auto_refresh": true,
  "hide_branding": true,
  "footer_links": [
    {
      "label": "<string>",
      "href": "<string>"
    }
  ],
  "metric_group_order": [
    "<string>"
  ],
  "metric_group_summary": true,
  "seo_description": "<string>",
  "seo_noindex": true,
  "custom_domain": {
    "domain": "<string>",
    "state": "<string>",
    "last_error": "<string>",
    "suspended": true
  },
  "config_key": "<string>",
  "managed_by": "config",
  "is_demo": true,
  "updated_at": "2023-11-07T05:31:56Z",
  "suspended": true,
  "suspended_at": "2023-11-07T05:31:56Z",
  "metrics": [
    {
      "metric_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "config_key": "<string>",
      "title": "<string>",
      "group": "<string>",
      "order": 123,
      "public_label": "<string>",
      "show_uptime": true
    }
  ],
  "changed": [
    "<string>"
  ]
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

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.

Path Parameters

string<uuid>

required

Page id.

Body

application/json

title

string

Page title. A new page defaults to its subdomain.

Required string length: 2 - 120

access_mode

enum<string>

Who can open the page. Only public can be set through the API (it clears any password, allow-list or SSO setting); the other modes carry credentials and are set in the console. Restating the page's current mode is a no-op.

Available options:

public,

password,

ip_allowlist,

jwt,

customer_scoped,

sso

layout

enum<string>

Page layout.

Available options:

minimal,

aurora,

blueprint

timezone

string

IANA time zone the page renders days and times in, e.g. Europe/London. Default UTC.

locale

enum<string>

Page language. Default en.

Available options:

en,

es,

fr,

de,

pt-BR,

it,

nl,

ja,

ar,

zh-CN

allow_subscriptions

boolean

Visitors can subscribe to updates.

show_auto_refresh

boolean

Show the auto-refresh control.

hide_branding

boolean

Hide the Powered by Observer footer link. Turning it on needs a paid plan.

footer_links

object[]

Links in the page footer, in order. Replaces the whole list.

Maximum array length: 5

Show child attributes

metric_group_order

(string | null)[] | null

Metric group names in display order (null is the ungrouped metrics). null restores the default order.

Maximum array length: 200

metric_group_summary

boolean

Show each metric group as one summary row.

seo_description

string | null

Search engine description. Empty or null uses the generated one.

Maximum string length: 300

seo_noindex

boolean

Ask search engines not to index the page.

theme

object

Apply a theme preset. Replaces the page's theme colours, fonts and spacing.

Show child attributes

Response

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.

footer_links

object[]

Show child attributes

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).

Show child attributes

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.

Show child attributes

changed

string[]

Settings that changed (empty when the request changed nothing).

Change a status page's settings

curl --request PATCH \
  --url https://use.observer/api/v1/pages/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://use.observer/api/v1/pages/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://use.observer/api/v1/pages/{id}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "subdomain": "<string>",
  "public_url": "<string>",
  "access_mode": "<string>",
  "layout": "<string>",
  "timezone": "<string>",
  "locale": "<string>",
  "allow_subscriptions": true,
  "show_auto_refresh": true,
  "hide_branding": true,
  "footer_links": [
    {
      "label": "<string>",
      "href": "<string>"
    }
  ],
  "metric_group_order": [
    "<string>"
  ],
  "metric_group_summary": true,
  "seo_description": "<string>",
  "seo_noindex": true,
  "custom_domain": {
    "domain": "<string>",
    "state": "<string>",
    "last_error": "<string>",
    "suspended": true
  },
  "config_key": "<string>",
  "managed_by": "config",
  "is_demo": true,
  "updated_at": "2023-11-07T05:31:56Z",
  "suspended": true,
  "suspended_at": "2023-11-07T05:31:56Z",
  "metrics": [
    {
      "metric_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "config_key": "<string>",
      "title": "<string>",
      "group": "<string>",
      "order": 123,
      "public_label": "<string>",
      "show_uptime": true
    }
  ],
  "changed": [
    "<string>"
  ]
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

Getting started

Account

Status pages

Services

Metrics

SLOs

SLA statements

Incidents

Maintenances

Config as code

Agents

Change events

Audit log

Change a status page's settings

Authorizations

Path Parameters

Body

Response