Skip to Content
Uptimeify Docs

Statusseiten

Statusseiten ermöglichen es, den Betriebsstatus überwachter Dienste für Kunden oder die Öffentlichkeit transparent darzustellen.

Sie können öffentlich zugänglich oder auf Kundenmitglieder beschränkt sein. Eigene Domains werden per DNS-Verifizierung eingebunden.

Authentifizierung

Alle Beispiele setzen einen Bearer-Token voraus:

BASE_URL="https://uptimeify.io"
TOKEN="<dein-api-token>"

Endpunkte

Kunde, Komponenten und Gruppen

Eine Statusseite gehört entweder zu einem Kunden (customerId) oder, ohne Kunde (customerId: null), zur ganzen Organisation. Eine Seite ohne Kunde sehen und verwalten nur organisationsweite Rollen und API-Token: kundengebundene Nutzer und Token bekommen sie nicht in Listen und erhalten auf ihren Komponenten- und Gruppen-Endpunkten 403.

Was eine Seite zeigt:

  • Komponenten: ausdrückliche Zeilen, jeweils ein Monitor (sourceKind: monitor) oder ein von Hand gepflegter Eintrag (sourceKind: manual), wahlweise in Gruppen gebündelt.
  • Kundenmonitore: Mit includeCustomerMonitors: true erscheint jeder Monitor des Kunden der Seite, außer denen in hiddenMonitors, automatisch hinter den Komponenten. Standard false für eine neue Seite (bis 28. Oktober 2026: true für eine Seite mit Kunde), damit ein neuer Monitor nie ungefragt öffentlich wird; bestehende Seiten behalten ihren gespeicherten Wert.

Auf einer Seite mit Kunde müssen Monitor-Komponenten Monitore dieses Kunden sein, auf einer Seite ohne Kunde jeder Monitor der Organisation. Wird ein Monitor gelöscht, verschwinden seine Komponenten automatisch.

Geplante Wartungen

Kündige geplante Arbeiten auf deinen Statusseiten an: eine Wartung hat Titel, Beschreibung, Beginn und Ende und gilt für ganze Seiten oder einzelne Komponenten jeder Quelle (manuell, Monitor, Drittanbieter). Sie beginnt und endet von selbst; solange sie läuft, zeigen ihre Komponenten maintenance. Abonnenten bekommen eine Ankündigung, optional eine Erinnerung, optional den Beginn und das Ende, dazu deine Updates. Monitor-Wartungsfenster aus dem Monitoring (die auch Alarme pausieren) erscheinen weiter auf Seiten mit diesen Monitoren und bleiben im Monitoring.

Verwaltet und selbstverwaltet

Wie ein Monitor hat eine Seite mit Kunde eine Eigentumsklasse, managementType: managed (Standard, die Organisation betreibt die Seite) oder self_service (der Kunde betreibt sie). Organisationsweite Admins und Editoren ändern jede Seite. Kundengebundene Nutzer (auch mit der Rolle readonly) und kundengebundene API-Tokens ändern nur self_service-Seiten ihrer Kunden (Einstellungen, Komponenten, Gruppen), außer der Kunde hat die Ausnahme canEditManaged; eine managed-Seite antwortet mit 403 und data.code: managed_by_organization. Sie legen Seiten nur als self_service an, und nur, wenn das Paket des Kunden oder der Kunde Selbstverwaltung erlaubt (sonst 403 selfServiceNotAllowed). managementType setzen oder ändern nur Organisations-Admins (403 managementTypeOrgOnly). Das Design bleibt bei den Rollen admin und editor: readonly liest es auf jeder Seite im eigenen Bereich, ändert es aber nicht, auch nicht auf eigenen self_service-Seiten.

Wer eine Statusseite ändern darf

Eine Regel gilt für eine Seite und alles, was an ihr hängt: Einstellungen, Komponenten und Gruppen, eigene Domain, Abonnenten (auch das Lesen, es sind personenbezogene Daten), Vorfälle und Wartungen auf der Seite.

  • Organisationsweite Aufrufer (Organisationsnutzer und Organisations-API-Tokens): Rolle admin oder editor. Organisationsweites readonly liest nur und bekommt 403 forbidden.
  • Kundengebundene Aufrufer (Kundennutzer, auch mit der Rolle readonly, und kundengebundene API-Tokens): Es entscheidet der managementType der Seite, nicht die Rolle. self_service-Seiten ja; managed-Seiten nur, wenn der Kunde die Ausnahme canEditManaged hat; sonst 403 mit data.code: managed_by_organization. Das gilt auch für einen kundengebundenen editor.
  • Ein Vorfall oder eine Wartung muss für jede Seite passen, mit der er oder sie verknüpft ist (beim Anlegen: jede Seite in statusPageIds). Ohne verknüpfte Seite gilt weiter die Rolle (admin oder editor).

Ausnahmen: Eine Seite zu löschen bleibt zusätzlich zur Eigentumsklasse an die Rolle gebunden (readonly löscht nie); eine eigene Domain verifizieren und aktivieren braucht für organisationsweite Aufrufer admin; Vorlagen und das Modul bleiben bei den Organisations-Admins. canEdit in Statusseiten auflisten und Statusseite abfragen sagt dir vorab, ob du eine Seite nach dieser Regel ändern darfst.

Ein Kundennutzer, der eine Seite nicht ändern darf, bittet stattdessen die Organisation darum, mit Änderungsanfrage zu einer Statusseite anlegen. So bittet ein Kunde die Organisation auch, eine self_service-Seite zu übernehmen.

Modul und Grenzen

Statusseiten sind ein Modul, das jede Organisation einmal mit Statusseiten-Modul aktivieren einschaltet. Solange es aus ist, antwortet jeder Endpunkt dieser Seite mit 403 und data.code: statusPagesModuleDisabled, außer Statusseiten-Modul abfragen, der Aktivierung selbst und den öffentlichen Endpunkten.

Eine Organisation hat beliebig viele Statusseiten. Das Paket eines Kunden kann die Statusseiten je Kunde begrenzen (maxStatusPages in der Paketkonfiguration, null = unbegrenzt); eine weitere Seite für diesen Kunden anzulegen oder eine Seite zu ihm umzuhängen antwortet mit 409 und data.code: statusPageLimitReached, die Grenze steht in data.max. Seiten ohne Kunde zählen nie. Eine Seite hat höchstens 500 Komponenten und höchstens 500 Gruppen; eine weitere antwortet mit demselben Code, die Grenze steht in data.max. Zielgruppen haben eigene Grenzen: höchstens 20 je Seite, jede mit höchstens 20 E-Mail-Domains und höchstens 100 Komponenten. Mehr antwortet mit 400 (invalidRequestBody).

Die öffentlichen Endpunkte, der RSS-Feed und eigene Domains antworten mit 404 (statusPageNotFound) für eine Seite, deren Organisation gesperrt oder gelöscht ist oder das Modul ausgeschaltet hat, genau wie bei einer nicht veröffentlichten Seite. Abonnenten einer solchen Seite bekommen keine Benachrichtigungen, bis die Organisation wieder aktiv ist. Abmelden geht immer.

Auf dieser Seite