Set a status page's password and IP allowlist. A page with either is private.

PUT

/status_page/{status_page_id}/access

curl --request PUT \
  --url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/access \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "password": "example", "ip_allowlist": [ "example" ] }'

• Production

Authorizations

• bearer_auth

Parameters

Path Parameters

status_page_id

required

string format: uuid

Status page identifier

Request Body ^required

Media type application/json

A change to a page’s access. A field left out stays as it is. Any change to the password or the allowlist signs out every visitor.

object

password

8 to 256 characters. null removes the password.

string | null

ip_allowlist

At most 50 IPv4 or IPv6 addresses or CIDR blocks. [] removes them all.

array | null

Example ^generated

{
  "password": "example",
  "ip_allowlist": [
    "example"
  ]
}

Responses

200

The page’s access after the change. A changed password or allowlist signs out every visitor

Media type application/json

Who may see a status page. The password itself is never returned.

object

visibility

required

Public: anyone with the link. Private: a password, an IP allowlist, or both.

string

Allowed values: public private

has_password

required

boolean

ip_allowlist

required

Addresses and CIDR blocks whose visitors skip the password, e.g. 203.0.113.0/24.

Array<string>

private_pages_used

required

The account’s private pages, this one included when it is private.

integer format: int64

private_pages_limit

How many pages may be private; null is unlimited. Each Private status page add-on adds one.

integer | null format: int64

Example

{
  "visibility": "public"
}

400

A password under 8 or over 256 characters, an entry that is not an IP address or CIDR block, or more than 50 entries

401

Missing or invalid authentication

402

Every private page the plan includes is in use; the message names the Private status page add-on

404

Status page not found

500

Internal server error