Skip to content

Set the monitors shown on a status page

POST
/status-pages/{id}/monitors
curl --request POST \
--url https://api.perstat.io/status-pages/example/monitors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "monitors": [ { "display_name": "example", "group_label": "example", "monitor": "example", "show_sparkline": true, "show_uptime_bars": true, "show_uptime_chart": true, "uptime_window_days": 1 } ] }'

Replaces the full ordered list of monitors shown on the status page, with per-entry display options such as display name, group label, and which uptime visualizations are shown. Returns the updated status page detail. Requires project management rights.

id
required
string
Media typeapplication/json
object
monitors
required

Geordnete Monitor-Liste (Position = sort_order).

Array<object>
object
display_name
string | null
group_label

Gruppen-Override (leer/null → Projektname als Default-Gruppe).

string | null
monitor
required

Monitor-public_id (mon_…).

string
show_sparkline
boolean
show_uptime_bars
boolean
show_uptime_chart
boolean
uptime_window_days

7|14|30|90|180|365 (sonst → 90).

integer format: int32
Examplegenerated
{
"monitors": [
{
"display_name": "example",
"group_label": "example",
"monitor": "example",
"show_sparkline": true,
"show_uptime_bars": true,
"show_uptime_chart": true,
"uptime_window_days": 1
}
]
}
Media typeapplication/json
object
has_logo
required

Ob die Seite ein Logo hat (für den Editor).

boolean
has_logo_dark
required

Ob die Seite ein Dark-Mode-Logo hat (für den Editor).

boolean
monitors
required
Array<object>
object
display_name

Rohe abweichende Bezeichnung (null → Monitor-Name) — für den Editor.

string | null
group_label

Gruppen-Override (null → Projektname als Default-Gruppe) — für den Editor.

string | null
label
required

Effektives öffentliches Label (Override oder Monitor-Name).

string
monitor
required

Monitor-public_id (mon_…).

string
project
required

Projektname des Monitors = Default-/Platzhalter-Gruppe.

string
show_sparkline
required
boolean
show_uptime_bars
required
boolean
show_uptime_chart
required
boolean
sort_order
required
integer format: int32
uptime_window_days
required

Uptime/Historie-Fenster in Tagen (7|14|30|90|180|365).

integer format: int32
page
required
object
collapsed_groups
required

Gruppen-Namen, die auf der publizierten Seite standardmäßig eingeklappt sind.

Array<string>
description
string | null
enabled
required
boolean
header_nav
required

Header-Navigation (Label + URL).

Array<object>

Ein Navigationselement der Header-Bar.

object
href
required
string
label
required
string
headline
string | null
hide_datargo_brand
required

Per-Seite-Schalter „Perstat-Branding ausblenden“. Wirksam nur zusammen mit der Tarif-Cap monitor.white_label (siehe white_label_available im Detail-DTO); ohne Cap bleibt der gespeicherte Wert wirkungslos.

boolean
id
required
string
name
required
string
organization_id
required
string
password_protected
required

Privat: publizierte Seite hinter Viewer-Login (orthogonal zu public_viewable).

boolean
public_viewable
required
boolean
shared_password_protected
required

Gemeinsames Kennwort: EIN geteiltes Passwort schaltet die ganze Seite frei (orthogonal zu public_viewable, mutually-exclusive zu password_protected).

boolean
shared_password_set
required

Ob ein geteiltes Kennwort GESETZT ist (Hash vorhanden). Niemals das Klartext — nur dieser bool, damit der Editor „gesetzt/leer“ anzeigen kann.

boolean
slug
required
string
Examplegenerated
{
"has_logo": true,
"has_logo_dark": true,
"monitors": [
{
"display_name": "example",
"group_label": "example",
"label": "example",
"monitor": "example",
"project": "example",
"show_sparkline": true,
"show_uptime_bars": true,
"show_uptime_chart": true,
"sort_order": 1,
"uptime_window_days": 1
}
],
"page": {
"collapsed_groups": [
"example"
],
"description": "example",
"enabled": true,
"header_nav": [
{
"href": "example",
"label": "example"
}
],
"headline": "example",
"hide_datargo_brand": true,
"id": "example",
"name": "example",
"organization_id": "example",
"password_protected": true,
"public_viewable": true,
"shared_password_protected": true,
"shared_password_set": true,
"slug": "example"
}
}