Update a status page

PUT

/api/v1/status-pages/{id}

• Production

Updates an existing status page. Only the fields provided in the request body are changed. To set a password, include the password field. To remove a password, send an empty string. Omit the field to keep it unchanged.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

integer

Example

5

Unique status page identifier.

Request Body ^required

object

name

string

description

string

password

Set a new password, send empty string to remove password, omit to keep unchanged.

string

monitor_ids

Array<integer>

Responses

200

Status page updated 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

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

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"
}

404

The requested resource was not found.

Error response returned when a request fails.

object

error

required

A human-readable error message.

string

Example

monitor not found

Example

{
  "error": "not found"
}