Sign in
Status Page

Create a status page (unpublished)

Changed on
post/projects/{project_id}/status-pages

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/status-pages
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Request body

descriptionstring nullable

Optional short text shown under the title.

titlestring required

Public page title, e.g. "Acme status".

Response

Status page created, not yet published

created_atstring date-time required
descriptionstring nullable
idinteger required
is_publishedboolean required
project_idinteger required
public_json_urlstring required

Machine-readable form of the public page.

public_urlstring required

Public HTML page. Serves 404 while the page is unpublished.

published_atstring date-time nullable
slugstring required

Unguessable token in the public URL.

titlestring required
updated_atstring date-time required

Changes