Get who may see a status page.

GET

/status_page/{status_page_id}/access

const url = 'https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/access';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/access \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

status_page_id

required

string format: uuid

Status page identifier

Responses

200

Public or private, whether a password is set (never the password), the IP allowlist and the account’s private page use

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

401

Missing or invalid authentication

404

Status page not found

500

Internal server error