Skip to Content
Uptimeify Docs

Statusseite erstellen

Erstellt eine neue Statusseite. Erfordert die Rolle `admin` oder `editor`; kundengebundene Nutzer und Tokens (auch `readonly`) legen selbstverwaltete Seiten ihrer Kunden an.

POST /api/status-pages

Request-Body

FeldTypPflichtStandardBeschreibung
customerIdnumberNein-Kunden-ID (muss zu deiner Organisation gehören). Weglassen für eine Seite der ganzen Organisation, ohne Kunde; die dürfen nur organisationsweite Rollen und API-Token anlegen.
includeCustomerMonitorsbooleanNeinfalseJeden Monitor des Kunden, außer denen in hiddenMonitors, automatisch hinter den ausdrücklichen Komponenten anzeigen, auch später angelegte Monitore. Ohne Kunde wirkungslos. Bis 28. Oktober 2026 war der Standard true für eine Seite mit Kunde; wer das beibehalten will, sendet true.
managementTypestringNeinmanagedmanaged oder self_service, wie bei Monitoren. Wählen dürfen nur Organisations-Admins; kundengebundene Nutzer und Tokens legen immer self_service-Seiten an.
namestringJa-Anzeigename (1-120 Zeichen). Slug wird aus dem Namen generiert.
slugstringNeinautoURL-Slug (1-120 Zeichen, auto-normalisiert auf Kleinbuchstaben-Bindestriche)
descriptionstringNeinnullBeschreibung (max. 1000 Zeichen)
visibilitystringNeinpublicpublic, customer_members_only, password_protected (jeder mit dem Seitenpasswort, siehe unten) oder sso_members_only (wie customer_members_only, zusätzlich muss die Sitzung über das Single Sign-on deiner Organisation entstanden sein)
accessPasswordstringNein-Seitenpasswort, 8-200 Zeichen. Pflicht bei visibility: password_protected. Nur schreibbar: gespeichert als bcrypt-Hash und nie zurückgegeben; Antworten zu Statusseiten zeigen nur hasPassword und accessPasswordSetAt.
ipAllowlistarrayNein[]IPv4-/IPv6-Adressen oder CIDR-Bereiche (z. B. 203.0.113.0/24, 2001:db8::/32), höchstens 50. Nur Besucher aus diesen Netzen sehen die Seite, zusätzlich zur visibility. Gespeichert normalisiert als addr/prefix (203.0.113.7 wird 203.0.113.7/32), ohne Doppelte. [] = keine IP-Beschränkung.
isPublishedbooleanNeintrueOb die Seite öffentlich sichtbar ist
smsSubscriptionsEnabledbooleanNeinfalseSMS-Abos auf der öffentlichen Seite anbieten. Jede SMS geht vom SMS-Kontingent deiner Organisation ab und stoppt am SMS-Deckel. Braucht SMS-Kontingent (sonst 403 smsQuotaRequired). Besucher sehen die Option nur, solange die Plattform SMS senden kann und deine Organisation SMS-Kontingent hat.
pushSubscriptionsEnabledbooleanNeinfalseBrowser-Push-Abos auf der öffentlichen Seite anbieten. Besucher sehen die Option nur, solange die Plattform VAPID-Schlüssel hat.
customDomainHostnamestringNeinnullEigene Domain (3-253 Zeichen). Erzeugt einen ausstehenden DNS-Verifizierungseintrag.
hiddenMonitorsarrayNein[]Monitore, die auf dieser Statusseite ausgeblendet werden. Jeder Eintrag ist { "type": "http"|"dns"|"icmp"|"smtp"|"ssh"|"ftp"|"imap_pop", "id": <Monitor-ID> }. Leer lassen oder [] senden, um alle Monitore anzuzeigen (Standard). Später hinzugefügte Monitore erscheinen automatisch. Maximal 500 Einträge.

Private Seiten (seit 28. Oktober 2026).

  • password_protected: Wer das Seitenpasswort kennt, sieht die Seite. Besucher schalten sie über den verify-password-Endpunkt frei, der ein Zugriffs-Cookie für 30 Tage setzt; ohne dieses Cookie antwortet die öffentliche Seite 401 passwordRequired. Eine neue Seite mit password_protected ohne accessPassword wird mit 400 passwordRequired abgewiesen.
  • sso_members_only: wie customer_members_only (angemeldete Mitglieder des Kunden, bei einer Seite ohne Kunde der Organisation), zusätzlich muss die Sitzung über das Single Sign-on deiner Organisation (OIDC oder SAML) entstanden sein. Ohne Anmeldung oder mit einer Anmeldung ohne SSO antwortet die öffentliche Seite 401 ssoRequired. Solange deine Organisation kein bestätigtes SSO hat, wird der Wert mit 400 ssoNotConfigured abgewiesen.
  • ipAllowlist gilt zusätzlich zu jeder Sichtbarkeit: Besucher aus anderen Netzen bekommen 403 statusPageIpNotAllowed. Maßgeblich ist die Adresse, die unser Reverse Proxy sieht; ein vom Client mitgeschickter X-Forwarded-For-Header zählt nicht. Ein ungültiger Eintrag wird mit 400 (invalidRequestBody) abgewiesen.
  • audienceGroups (nur per PATCH): Jede Gruppe hat einen name (1-80 Zeichen), emailDomains (1-20 Domains, klein geschrieben gespeichert) und componentIds (1-100 Komponenten dieser Seite, numerische ID oder publicId; gespeichert als numerische IDs). Eine Komponente, die in einer Gruppe steht, zeigt die öffentliche Seite nur Besuchern, die mit einer bestätigten E-Mail-Adresse einer Domain dieser Gruppe angemeldet sind (genau diese Domain, Subdomains zählen nicht), sowie Admins und Editoren der Seite. Komponenten ohne Gruppe sieht jeder, der die Seite sehen darf. Vorfälle und Wartungen, die nur ausgeblendete Komponenten betreffen, fallen für diesen Besucher ebenfalls weg, und der Gesamtstatus ergibt sich aus dem, was er sieht.
  • Wenn angegeben, ersetzen ipAllowlist und audienceGroups den gespeicherten Wert vollständig.
  • Eine Seite mit ipAllowlist oder audienceGroups hat, wie jede Seite mit einer anderen Sichtbarkeit als public, kein Badge, kein Embed-Widget, keine Atom-/RSS-Feeds und nimmt keine Abos an (diese Adressen antworten 404 wie eine fehlende Seite). Bestehende Abonnenten einer solchen Seite bekommen keine Benachrichtigungen mehr.

Beispiel (cURL)

curl -X POST "$BASE_URL/api/status-pages" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": 5,
    "name": "Production Status",
    "description": "Real-time status of our production services",
    "visibility": "public",
    "hiddenMonitors": [{ "type": "http", "id": 42 }]
  }'

Antwort

{
  "statusPage": {
    "id": 1,
    "publicId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organizationId": 1,
    "customerId": 5,
    "includeCustomerMonitors": true,
    "managementType": "managed",
    "name": "Production Status",
    "slug": "production-status",
    "description": "Real-time status of our production services",
    "visibility": "public",
    "isPublished": true,
    "showRecentIncidents": false,
    "showRecentMaintenance": false,
    "customDomainId": null,
    "ipAllowlist": [],
    "audienceGroups": [],
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-01-15T10:00:00.000Z"
  },
  "dns": null
}

Wird customDomainHostname angegeben, enthält die Antwort DNS-Verifizierungshinweise:

{
  "dns": {
    "txtName": "_verify-status.status.deinkunde.com",
    "txtValue": "abc123-def456-ghi789"
  }
}

Die Seite startet ohne Komponenten. Lege sie mit Komponente erstellen an.

Kompatibilität: Seit dem 27.10.2026 kann customerId in Antworten null sein (eine Seite der ganzen Organisation, ohne Kunde), ebenso customerPublicId und customerName, wo vorhanden. Ein Client, der annimmt, dass customerId immer eine Zahl ist, muss null behandeln.

Häufige Fehler

  • 401 Unauthorized, wenn nicht authentifiziert
  • 403 Forbidden (forbidden), wenn ein organisationsweiter Aufrufer weder die Rolle admin noch editor hat, oder für einen Global Supporter
  • 403 Forbidden (forbidden), wenn ein kundengebundener readonly-Nutzer oder ein von ihm ausgestellter Token showRecentIncidents oder showRecentMaintenance schickt: das Design verlangt die Rolle admin oder editor
  • 403 Forbidden (selfServiceNotAllowed), wenn ein kundengebundener Nutzer oder Token eine Seite anlegt und das Paket des Kunden keine Selbstverwaltung erlaubt
  • 403 Forbidden (forbidden), wenn ein kundengebundener Nutzer oder Token customerId weglässt oder einen Kunden außerhalb seines Bereichs nennt
  • 404 Not Found (customerNotFound), wenn customerId kein Kunde deiner Organisation ist
  • 403 Forbidden (statusPagesModuleDisabled), wenn das Statusseiten-Modul nicht aktiviert ist
  • 409 Conflict, wenn der Slug bereits vergeben ist
  • 409 Conflict (statusPageLimitReached, mit data.max), wenn das Paket des Kunden keine weiteren Statusseiten erlaubt (maxStatusPages); Seiten ohne Kunde sind unbegrenzt
  • 403 Forbidden (smsQuotaRequired), wenn smsSubscriptionsEnabled true ist und deine Organisation gerade keine SMS senden kann (kein Inklusivvolumen mehr, Mehrnutzung aus oder SMS-Deckel erreicht)
  • 400 Bad Request (passwordRequired), wenn visibility password_protected ist und accessPassword fehlt
  • 400 Bad Request (invalidRequestBody), wenn accessPassword kürzer als 8 oder länger als 200 Zeichen ist
  • 400 Bad Request (ssoNotConfigured), wenn visibility sso_members_only ist und deine Organisation kein bestätigtes Single Sign-on hat
  • 400 Bad Request (invalidRequestBody), wenn ein Eintrag in ipAllowlist keine IPv4-/IPv6-Adresse und kein CIDR-Bereich ist oder die Liste mehr als 50 Einträge hat

Auf dieser Seite