Status Page

Update a status page's title, description or monitor selection

Changed on
patch/status-pages/{status_page_id}

Request

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

Path parameters

status_page_idinteger required

Status page ID

Request body

descriptionstring nullable

New description. An empty string clears it; omit to keep it.

titlestring nullable

Response

Status page updated; a published page is re-rendered immediately

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