Skip to content
Pong Docs

Create a status page

POST
/api/v1/status-pages

Creates a new status page for the authenticated user. A unique token is generated automatically and used as the public URL path. An optional password can be set to restrict access.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
name
required
string
Example
Production Status
description
string
Example
Status page for production services
password

Optional password to protect the page. Omit or leave empty for no password.

string
Example
s3cret
monitor_ids
Array<integer>
Example
[
  1,
  2,
  3
]

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Status page created successfully.

object
id
integer
Example
1
user_id
integer
Example
1
name
string
Example
Production Status
token

Unguessable token used as the public URL path.

string
Example
a8f3b2c1d4e5f6a7b8c9d0e1f2a3b4c5
description
string
Example
Status page for production services
has_password

Whether the page requires a password to view.

boolean
created_at
string format: date-time
Example
2026-03-29T10:00:00Z
updated_at
string format: date-time
Example
2026-03-29T10:00:00Z
monitor_ids
Array<integer>
Example
[
  1,
  2,
  3
]

400

Section titled “400 ”

The request body is invalid or missing required fields.

Error response returned when a request fails.

object
error
required

A human-readable error message.

string
Example
monitor not found
Example
{
  "error": "invalid request body"
}

401

Section titled “401 ”

Authentication credentials are missing or invalid.

Error response returned when a request fails.

object
error
required

A human-readable error message.

string
Example
monitor not found
Example
{
  "error": "unauthorized"
}