12.1Create your status page

You set up the page in the dashboard. The page's address is the last part of its web address, such as acme in https://www.obsrvly.com/status/acme.

Select alerting in the top navigation, then status page.
Wait for the form to load. If you see couldn't load the status page settings, select try again.
In address, enter a short name, such as acme. The full address is shown next to the field.
In title, enter the name visitors see at the top, such as Acme status.
Optionally, enter a description of one or two lines.
Add monitors under monitors on the page (12.2).
Check Publish the page.
Select save. You see Saved. The public page shows a change within about a minute.

After you save a published page, an open link appears next to save. It opens your public page in a new tab. The link uses the saved address, not what you are typing now.

If the page is not published, you see the page is not published. Before your first save, you see nothing is public until you publish.

Fields and limits#

Field	Required	Rules
Publish the page	No	Off for a new page. Only a published page is public.
address	Yes	3 to 40 lowercase letters, digits or hyphens. Must start and end with a letter or digit. The form makes letters lowercase as you type.
title	Yes	Up to 80 characters. No line breaks.
description	No	Up to 280 characters. No line breaks.

An address belongs to one team only. Your team keeps its address while the page is off.
Some words cannot be used as an address, such as admin, api, status and www.
You can change the address later. The old address then stops working (12.5).
save stays greyed out until the address has the right form, the title is filled in, and every public name is filled in.

If saving fails#

The message appears in a red box at the top of the form.

Message	What to do
`status page address already taken`	Another team uses this address. Choose a different one.
`invalid input: the address "<address>" is reserved`	This word cannot be used. Choose a different address.
`invalid input: the address must be 3 to 40 lowercase letters, digits or hyphens, and start and end with a letter or digit`	Fix the address. The same rule shows under the field while you type.
`invalid input: title required`	Enter a title.
`invalid input: title must be at most 80 characters`	Shorten the title.
`invalid input: description must be at most 280 characters`	Shorten the description.
`invalid input: <field> must not contain control characters`	Remove line breaks and other special characters from that field.
`this workspace is suspended — contact support`	Contact support. A suspended team cannot save, and its page is not public.

Owners can see each change to the page in the audit log, under the filter status page (14.5).

Use the API#

You can read and save the page with an API key (chapter 13). Both the dashboard and the API can do everything in this section.

Read your status page settings

BASE=https://www.obsrvly.com/api/gw/monitor/obsrvly.v1.MonitorConfigService

curl -s $BASE/GetStatusPage \
  -H "Authorization: Bearer $OBSRVLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Before your first save, page in the answer is empty.

Save and publish your status page

bash

curl -s $BASE/SaveStatusPage \
  -H "Authorization: Bearer $OBSRVLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page": {
        "enabled": true,
        "slug": "acme",
        "title": "Acme status",
        "description": "Live status of Acme services.",
        "monitors": [
          {"monitorId": "<monitor-id>", "publicName": "Website"},
          {"monitorId": "<monitor-id>", "publicName": "API"}
        ]}}'

enabled is Publish the page. slug is the address.
The dashboard makes the address lowercase and checks its form before you save. The API does not. It answers invalid_argument (400) instead.
A taken address answers already_exists (409). A reserved or badly formed address, or a missing title, answers invalid_argument (400).
The answer includes updatedAt. It is ignored if you send it back.