OPopenstatus
page

Create a status page

Changed on
post/page

Request

  • Base URL
    https://api.openstatus.dev (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-openstatus-key

Request body

titlestring required

The title of the page

descriptionstring required

The description of the page

slugstring required

The slug of the page

customDomainstring nullable

The custom domain of the page. To be configured within the dashboard.

passwordProtectedboolean

Deprecated in favor of accessType. Used to set the password protection type. Returns true if accessType is set to 'password' and false otherwise.

accessType'public' | 'password' | 'email-domain'

The access type of the page

passwordstring nullable

Your password to protect the page from the public

authEmailDomainsstring[] nullable

The email domains of the page

showMonitorValuesboolean nullable

Displays the total and failed request numbers for each monitor. Deprecated and will be removed in the future in favor for configuration property.

Example request

{
  "title": "My Page",
  "description": "My awesome status page",
  "slug": "my-page",
  "customDomain": "status.acme.com",
  "passwordProtected": true,
  "accessType": "public",
  "password": "hidden-password",
  "authEmailDomains": [
    "example.com",
    "example.org"
  ],
  "showMonitorValues": true,
  "monitors": [
    1,
    2
  ]
}

Response

Get an Status page

idnumber required

The id of the page

titlestring required

The title of the page

descriptionstring required

The description of the page

slugstring required

The slug of the page

customDomainstring nullable

The custom domain of the page. To be configured within the dashboard.

passwordProtectedboolean

Deprecated in favor of accessType. Used to set the password protection type. Returns true if accessType is set to 'password' and false otherwise.

accessType'public' | 'password' | 'email-domain'

The access type of the page

passwordstring nullable

Your password to protect the page from the public

authEmailDomainsstring[] nullable

The email domains of the page

showMonitorValuesboolean nullable

Displays the total and failed request numbers for each monitor. Deprecated and will be removed in the future in favor for configuration property.

Example response

{
  "id": 1,
  "title": "My Page",
  "description": "My awesome status page",
  "slug": "my-page",
  "customDomain": "status.acme.com",
  "passwordProtected": true,
  "accessType": "public",
  "password": "hidden-password",
  "authEmailDomains": [
    "example.com",
    "example.org"
  ],
  "showMonitorValues": true,
  "monitors": [
    1,
    2
  ]
}

Changes

  • a3ef7e6cc6acRevision changes
    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status