Skip to content
Site Qwality Site Qwality Site Qwality Docs

Replace the page layout: the groups, their order, and which components sit in each.

PUT
/status_page/{status_page_id}/layout
 
curl --request PUT \
  --url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/layout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ungrouped": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "description": "example", "hidden": true, "show_uptime": true } ], "groups": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "components": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "description": "example", "hidden": true, "show_uptime": true } ] } ] }'

The whole layout is saved at once. Groups left out are removed. A component left out goes to the end of the ungrouped list and keeps its description, hidden and uptime settings.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
status_page_id
required
string format: uuid

Status page identifier

Request Body required

Section titled “Request Body required ”
Media type application/json
object
ungrouped
Array<object>
object
id
required

A component already on this page (its id from the layout). monitor_id is accepted too.

string format: uuid
description

Up to 200 characters, one line.

string | null
hidden
boolean
show_uptime
boolean
groups
Array<object>
object
id

An existing group to keep and rename or reorder. Leave out to create one.

string | null format: uuid
name
required

Up to 100 characters.

string
description

Up to 500 characters.

string | null
components
Array<object>
object
id
required

A component already on this page (its id from the layout). monitor_id is accepted too.

string format: uuid
description

Up to 200 characters, one line.

string | null
hidden
boolean
show_uptime
boolean
Example generated
{
  "ungrouped": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "description": "example",
      "hidden": true,
      "show_uptime": true
    }
  ],
  "groups": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "description": "example",
      "components": [
        {
          "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "description": "example",
          "hidden": true,
          "show_uptime": true
        }
      ]
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The saved layout

Media type application/json
object
ungrouped
required

Shown first, above the groups.

Array<object>

A component on the page, as the page shows it.

object
id
required

What the layout and the component routes call it: the HTTP job, browser check or cron job id, or the manual component’s own id.

string format: uuid
monitor_id
required

The same value as id, kept for clients that predate manual components.

string format: uuid
kind
required
string
Allowed values: http_job browser_check cron_job manual
friendly_name
required
string
description

One line shown under the name, or null.

string | null
hidden
required

A hidden component stays on the page’s list but is left off the public page.

boolean
show_uptime
required

False shows the status only, with no uptime bars or percentage. Heartbeats and manual components never show uptime.

boolean
status
One of:

The status the owner set on a manual component; null for every other kind.

string
Allowed values: operational degraded down maintenance
status_override
One of:

The override in force, or null. One past its expiry reads as null.

object
status
required

What the owner says a component is doing: a manual component’s status, or an override on any component. Stored as text (status_page_components.manual_status, *.override_status).

string
Allowed values: operational degraded down maintenance
note
string | null
expires_at

When it lapses on its own, or null to keep it until cleared.

string | null format: date-time
set_at
string | null format: date-time
groups
required

In the order the page shows them.

Array<object>
object
id
required
string format: uuid
name
required
string
description
string | null
components
required

In the order the page shows them.

Array<object>

A component on the page, as the page shows it.

object
id
required

What the layout and the component routes call it: the HTTP job, browser check or cron job id, or the manual component’s own id.

string format: uuid
monitor_id
required

The same value as id, kept for clients that predate manual components.

string format: uuid
kind
required
string
Allowed values: http_job browser_check cron_job manual
friendly_name
required
string
description

One line shown under the name, or null.

string | null
hidden
required

A hidden component stays on the page’s list but is left off the public page.

boolean
show_uptime
required

False shows the status only, with no uptime bars or percentage. Heartbeats and manual components never show uptime.

boolean
status
One of:

The status the owner set on a manual component; null for every other kind.

string
Allowed values: operational degraded down maintenance
status_override
One of:

The override in force, or null. One past its expiry reads as null.

object
status
required

What the owner says a component is doing: a manual component’s status, or an override on any component. Stored as text (status_page_components.manual_status, *.override_status).

string
Allowed values: operational degraded down maintenance
note
string | null
expires_at

When it lapses on its own, or null to keep it until cleared.

string | null format: date-time
set_at
string | null format: date-time
Example 
{
  "ungrouped": [
    {
      "kind": "http_job",
      "status": "operational",
      "status_override": {
        "status": "operational"
      }
    }
  ],
  "groups": [
    {
      "components": [
        {
          "kind": "http_job",
          "status": "operational",
          "status_override": {
            "status": "operational"
          }
        }
      ]
    }
  ]
}

400

Section titled “400 ”

A component or group is not on this page, appears twice, or a text is too long

401

Section titled “401 ”

Missing or invalid authentication

404

Section titled “404 ”

Status page not found

500

Section titled “500 ”

Internal server error

Privacy Cookie preferences