Skip to Content
Uptimeify Docs

Öffentliche Statusseite abfragen

Zwei Endpunkte liefern die öffentliche Statusseiten-Ansicht:

  • GET /api/status-pages/public/:slug: Abruf per URL-Slug
  • GET /api/status-pages/public/by-id/:id: Abruf per numerischer ID

Keine Authentifizierung nötig für Seiten mit visibility: public. Für Seiten mit visibility: customer_members_only ist eine Kundenmitglieds-Authentifizierung erforderlich. Eine customer_members_only-Seite ohne Kunde steht jedem angemeldeten Mitglied ihrer Organisation offen.

Seiten mit visibility: sso_members_only funktionieren wie customer_members_only und verlangen zusätzlich eine Sitzung aus dem Single Sign-on der Organisation: Ohne Anmeldung oder mit einer Anmeldung ohne SSO antworten beide Endpunkte 401 ssoRequired.

Seiten mit visibility: password_protected verlangen das Seitenpasswort: Ohne gültiges Zugriffs-Cookie antworten beide Endpunkte 401 passwordRequired. Der Besucher schaltet die Seite so frei:

POST /api/status-pages/public/:slug/verify-password

{ "password": "das Seitenpasswort" }

Die Antwort ist { "ok": true } und setzt das httpOnly-Cookie sp_access_<Seiten-ID> (Pfad /, 30 Tage gültig, SameSite=Lax, Secure). Schick es bei späteren Anfragen an beide Endpunkte mit. Ein neues Passwort über Statusseite aktualisieren macht jedes vorher ausgegebene Cookie ungültig. Die Prüfung erlaubt 10 Versuche pro Minute je IP-Adresse und Seite; darüber antwortet sie 429 mit data.retryAfter. Fehler: 400 passwordRequired (Passwort leer oder fehlt), 401 invalidPassword (falsches Passwort), 404 statusPageNotFound (keine veröffentlichte Seite mit diesem Slug, oder die Seite ist nicht passwortgeschützt).

Eine Seite mit IP-Freigabeliste (ipAllowlist) antwortet Besuchern aus anderen Netzen mit 403 statusPageIpNotAllowed, unabhängig von ihrer Sichtbarkeit. Das gilt für beide Abfragen und für die Passwortprüfung einer geschützten Seite (verify-password); das Passwort wird dann gar nicht erst geprüft. Maßgeblich ist die Adresse, die unser Reverse Proxy sieht, nicht ein vom Client mitgeschickter X-Forwarded-For-Header.

Mit Zielgruppen (audienceGroups) fehlen in components die Komponenten der Gruppen, zu denen der Besucher nicht gehört (angemeldet mit einer bestätigten E-Mail-Adresse einer Domain der Gruppe; Admins und Editoren der Seite sehen alles), ebenso Vorfälle und Wartungen, die nur diese Komponenten betreffen; overallStatus und overallState ergeben sich aus dem, was der Besucher sieht. Antworten für eine Seite mit IP-Freigabeliste oder Zielgruppen tragen Cache-Control: private, no-store.

Badge (/status/:slug/badge.svg), Embed-Widget (/status/:slug/embed), Atom-/RSS-Feeds und Abos gibt es nur für Seiten mit visibility: public ohne IP-Freigabeliste und ohne Zielgruppen; für jede andere Seite antworten sie 404 wie eine fehlende Seite.

Vorschau einer unveröffentlichten Seite. GET /api/status-pages/public/:slug antwortet auch für eine Seite mit isPublished: false, wenn die Anfrage als Mitglied der eigenen Organisation der Seite angemeldet ist, mit Zugriff auf den Design-Editor (admin, editor oder readonly), und bei einer Seite mit Kunde dieser Kunde im eigenen Bereich liegt. Die Antwort ist dieselbe, mit isPublished: false und Cache-Control: private, no-store; die öffentliche Seite zeigt ein Banner „Vorschau, nicht öffentlich“. Alle anderen, auch Mitglieder fremder Organisationen und anonyme Besucher, bekommen 404 statusPageNotFound. Die Abfrage per ID, Badge, Widget, Feeds und eigene Domains liefern nur veröffentlichte Seiten aus.

Antwort

{
  "statusPage": {
    "id": 1,
    "name": "Production Status",
    "slug": "production-status",
    "description": "Real-time status of our production services",
    "visibility": "public",
    "isPublished": true,
    "showRecentIncidents": true,
    "showRecentMaintenance": true,
    "overallState": "degraded",
    "overallStatus": "partial_outage",
    "smsSubscriptionsEnabled": true,
    "pushPublicKey": "BOr3...base64url...",
    "productName": "Northwind Monitoring",
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-01-15T10:00:00.000Z"
  },
  "websites": [
    {
      "id": 101,
      "name": "Main Site",
      "url": null,
      "status": "active",
      "state": "operational",
      "publicStatus": "operational",
      "inMaintenance": false,
      "openIncidents": 0,
      "lastCheckedAt": "2026-05-01T12:00:00.000Z"
    }
  ],
  "components": {
    "groups": [
      {
        "id": 3,
        "name": "Core services",
        "collapsed": false,
        "components": [
          {
            "id": 7,
            "name": "Main Site",
            "description": null,
            "sourceKind": "monitor",
            "monitorType": "http",
            "monitorId": 101,
            "manualStatus": null,
            "dependency": null,
            "state": "operational",
            "publicStatus": "operational",
            "showUptime": true,
            "uptimeDays": [],
            "availability": null
          }
        ]
      }
    ],
    "ungrouped": [
      {
        "id": 8,
        "name": "Payment provider",
        "description": "Card payments at checkout",
        "sourceKind": "manual",
        "monitorType": null,
        "monitorId": null,
        "manualStatus": "partial_outage",
        "dependency": null,
        "state": "degraded",
        "publicStatus": "partial_outage",
        "showUptime": true,
        "uptimeDays": [],
        "availability": null
      }
    ]
  },
  "maintenanceHistory": [],
  "scheduledMaintenances": [],
  "incidentHistory": [
    {
      "id": 5121,
      "websiteId": 0,
      "websiteName": "Card payments failing",
      "type": "manual",
      "status": "open",
      "startedAt": "2026-10-27T09:12:00.000Z",
      "resolvedAt": null,
      "title": "Card payments failing",
      "severity": "major",
      "source": "manual",
      "updates": [
        {
          "status": "investigating",
          "body": "We are looking into failed card payments.",
          "createdAt": "2026-10-27T09:13:00.000Z",
          "authorName": "Pascal H."
        }
      ],
      "affectedComponents": [
        { "id": 8, "name": "Payment provider", "impact": "partial_outage" }
      ],
      "postmortem": null
    }
  ]
}

state-Werte: operational, warning (nur SSL-Vorfälle), degraded (Nicht-SSL-Vorfälle), maintenance (aktives Wartungsfenster).

publicStatus (seit 27. Oktober 2026, an jeder Website und Komponente) trennt, was state zusammenfasst, im Vokabular von manualStatus und der üblichen Statusseiten-Anbieter:

publicStatusMonitorstate
operationalkein offener Vorfalloperational
maintenanceim Wartungsfenster, kein offener Vorfallmaintenance
degradednur ein Zertifikatshinweis (ssl_warning, ssl_expiry)warning
partial_outageantwortet, aber eine andere Prüfung schlägt fehl (Antwortzeit, Stichwort, Seitengröße, Weiterleitung, DNSBL)degraded
major_outagenicht erreichbar oder antwortet mit Fehlerstatus (downtime, http_status, ssl_handshake)degraded

state ist die Projektion von publicStatus aus der letzten Spalte und behält seine Bedeutung; neue Integrationen lesen besser publicStatus und overallStatus.

smsSubscriptionsEnabled ist true, wenn die Seite SMS-Abos anbietet, die Plattform SMS senden kann und die Organisation SMS-Kontingent hat. pushPublicKey ist der öffentliche VAPID-Schlüssel (base64url), den PushManager.subscribe als applicationServerKey bekommt, wenn die Seite Browser-Push anbietet, sonst null. Siehe Statusseite abonnieren.

overallStatus ist der schwerwiegendste publicStatus über alle Monitore der Seite und alle manuellen und dependency-Komponenten, mit einer Ausnahme: major_outage nur, wenn alle ausgefallen sind; der Totalausfall einzelner neben laufenden ergibt partial_outage. Ein seitenweit verknüpfter offener Vorfall zählt wie angegeben. Ein Override aus dem Incident Management gewinnt darüber (warning = degraded, degraded = major_outage). overallState ist die Projektion von overallStatus und wie bisher der schwerwiegendste state.

websites listet jeden Monitor der Seite: die Monitor-Komponenten und, mit includeCustomerMonitors, die Monitore des Kunden außer den ausgeblendeten. components listet nur die ausdrücklichen Komponenten, in sort-Reihenfolge: groups mit ihren Komponenten, dann ungrouped. Die automatisch eingeschlossenen Kundenmonitore stehen dort nicht noch einmal.

  • Eine Monitor-Komponente trägt den Zustand ihres Monitors. Sie fehlt, solange die Seite diesen Monitor nicht zeigt.
  • Eine manuelle Komponente trägt ihren manualStatus als publicStatus, übersetzt in state: operational zu operational, maintenance zu maintenance, degraded zu warning, partial_outage und major_outage zu degraded.
  • Eine manuelle Komponente trägt ihren manualStatus, angehoben vom schwersten offenen Vorfall, der mit ihr verknüpft ist (status_page_incident_link oder eine Statusseiten-Regel des Incident Managements mit componentIds). Der impact des Vorfalls wird genauso übersetzt. Ist der Vorfall behoben, gilt wieder der manualStatus.
  • Eine dependency-Komponente (sourceKind: dependency) trägt dependency (slug, name, status) mit dem Gesamtstatus, den wir für diesen Anbieter veröffentlichen. status wird übersetzt wie manualStatus; unknown (wir sehen den Anbieter nicht) wird publicStatus degraded (state warning) und zählt nicht zu overallStatus/overallState. Ein verknüpfter offener Vorfall hebt sie an wie eine manuelle Komponente. Sie hat keine uptimeDays.
  • uptimeDays und availability sind in jedem Layout gefüllt (seit 27. Oktober 2026, vorher nur im Statusboard): bei websites immer, bei Monitor-Komponenten mit showUptime.
  • Manuelle Komponenten mit showUptime haben ebenfalls uptimeDays und availability (seit 28. Oktober 2026), berechnet aus den mit ihnen verknüpften Vorfällen, auch nachgetragenen (Vorfall nachtragen): ein Vorfall mit Auswirkung partial_outage oder major_outage zählt von seinem Beginn bis zu seinem Ende auf den Seiten als Ausfall, degraded und maintenance nicht. Der Balken beginnt mit dem Anlegen der Komponente, bei einem älteren verknüpften Vorfall früher.
  • Ohne gebuchtes Monitoring (Testphase abgelaufen oder Monitoring gekündigt; Statusseiten bleiben kostenlos online) haben Monitore keinen Live-Zustand: Monitor-Komponenten und Einträge in websites melden state und publicStatus als operational (ebenso overallStatus, solange nichts anderes ihn hebt), angehoben nur von einem verknüpften offenen Vorfall wie bei einer manuellen Komponente, mit leerem uptimeDays, availability: null und showUptime: false. Monitor-Vorfälle erscheinen nicht mehr. Ist Monitoring wieder gebucht, gilt wieder der Zustand des Monitors.
  • GET /api/status-pages/public/by-id/:id kennt nur Websites: Monitor-Komponenten anderer Monitorarten lässt er weg.

Vorfälle und Wartungen (jedes Layout)

Seit dem 27. Oktober 2026 liefert der Endpunkt Vorfälle, ihre Update-Verläufe und Wartungsfenster für jedes Layout, nicht nur für das Statusboard, und auch für eine Seite ohne einen einzigen Monitor. incidentHistory ist neueste zuerst und auf incidentLimit aus dem Design gekappt; offene Vorfälle sind immer dabei, behobene innerhalb von incidentDays.

sourceWelche Vorfälle
monitorVorfälle eines Monitors der Seite.
manualManuelle Vorfälle, die mit dieser Seite verknüpft sind (POST /api/incidents mit statusPageIds), und manuelle Vorfälle des Kunden der Seite.
imVorfälle aus dem Incident Management, die eine Statusseiten-Regel dieser Seite trifft (Team und Schweregrad) und mindestens ein öffentliches Update haben. Ohne Update erscheint der Vorfall nicht in der Liste, die Regel-Komponenten zeigen aber trotzdem ihren Zielzustand. id ist die Kennung im Incident Management; updates ist die öffentliche Timeline aus POST /api/im/incidents/:id/statuspage-update; severity ist critical (sev1), major (sev2) oder minor. Team, Beteiligte und interne Notizen stehen nie in der Antwort.

affectedComponents nennt die Komponenten dieser Seite, die ein Vorfall betrifft, mit ihrem impact (degraded, partial_outage, major_outage, maintenance). Ein offener manueller Vorfall, der seitenweit (ohne Komponente) verknüpft ist, hebt overallStatus über seinen impact; ein manueller Vorfall des Kunden ohne Verknüpfung über seine severity (minor = degraded, major = partial_outage, critical = major_outage).

postmortem (seit 28. Oktober 2026) ist die veröffentlichte Nachbetrachtung eines Vorfalls, { body, publishedAt } mit body in Markdown, oder null. Die Layouts zeigen sie unter dem Vorfall als aufklappbaren Abschnitt, ohne rohes HTML. Siehe Postmortem veröffentlichen.

maintenanceHistory enthält jedes aktive Fenster, das eine Website der Seite betrifft: Fenster auf der Website selbst, auf mehreren Zielen, auf einem Tag (auch organisationsweit) und auf dem ganzen Kunden. websiteId/websiteName nennen eine Website der Seite, die das Fenster betrifft.

scheduledMaintenances listet die geplanten Wartungen der Seite selbst (siehe Wartung planen), neuester Beginn zuerst: id, title, description, scheduledFor, scheduledUntil, state (scheduled, in_progress, completed), affectedComponents (id, name; leer = die ganze Seite) und updates (body, createdAt, älteste zuerst). Bevorstehende Wartungen stehen ohne Grenze darin, abgeschlossene innerhalb von maintenanceDays, abgesagte nie; die Liste ist leer, solange das Design Wartungen ausblendet. Solange eine Wartung in_progress ist, tragen ihre Komponenten publicStatus: maintenance (ein schlimmerer Zustand bleibt), und eine Wartung ohne Komponenten hebt overallStatus mindestens auf maintenance, unabhängig vom Design.

Vorfallverlauf (historyPage)

GET /api/status-pages/public/:slug?historyPage=1 liefert den Vorfallverlauf so, wie ihn die öffentliche Seite unter Vorfallverlauf zeigt (/status/:slug?history=1, auf einer eigenen Domain ?history=1). Der Verlauf hat kein Ende in der Vergangenheit: Seite 1 ist der laufende Kalendermonat und die zwei davor, Seite 2 die drei Monate davor und so weiter (Monate in UTC). Mit historyPage listet incidentHistory jeden Vorfall, der in diesem Zeitraum begann, offen oder behoben, höchstens 200, neueste zuerst, unabhängig von incidentDays und incidentLimit; alles andere in der Antwort (Zustand, Komponenten, Balken, Wartungen) bleibt gleich. Die Verfügbarkeitsbalken behalten ihre Grenze von 90 Tagen.

Die Antwort trägt dann history:

{
  "history": {
    "page": 2,
    "from": "2026-05-01T00:00:00.000Z",
    "to": "2026-08-01T00:00:00.000Z",
    "hasOlder": true
  }
}

from ist inklusiv, to exklusiv; hasOlder sagt, ob es ältere Vorfälle gibt (Seite 3). historyPage ist eine ganze Zahl von 1 bis 400, alles andere antwortet 400 invalidRequestBody. Blendet das Design Vorfälle aus (showIncidents: false), ist die Liste leer und hasOlder ist false.

GET /api/status-pages/public/by-id/:id liefert manuelle und verknüpfte Vorfälle ebenfalls, ohne source, updates, affectedComponents und postmortem, und keine Vorfälle aus dem Incident Management.

statusPage.designConfig.statusLabels enthält die eigenen Texte der Seite je Zustand (siehe Statusseiten-Design aktualisieren); ein Zustand ohne eigenen Text zeigt den Standardtext. Seite, Badge und Widget verwenden sie.

productName ist der White-Label-Produktname Ihrer Organisation, oder null, wenn Sie keinen gesetzt (oder ihn ausgeblendet) haben. Der Footer der Seite verwendet ihn für die „Powered by"-Zeile.

url ist null, solange im Design der Seite Service-URLs anzeigen nicht eingeschaltet ist (designConfig.showServiceUrls: true). Bis zum 4. September 2026 war das Feld immer gefüllt und nur die gerenderte Seite hat es ausgeblendet; bei Nicht-HTTP-Monitoren stand darin der rohe Hostname eines Mail-, SSH- oder FTP-Servers. Den Design-Schalter setzt jetzt der Server durch.

incidentHistory[].updates[].authorName ist der Vorname des Autors plus der Anfangsbuchstabe des Nachnamens, z. B. "Pascal H.", nie der vollständige Name.

Diese Antwort enthält organizationId und customerId nicht mehr. Das waren interne Datensatz-IDs, die dieser öffentliche Endpunkt jedem Besucher jeder veröffentlichten Seite auslieferte; die gerenderte Seite hat sie nie verwendet. Falls Sie sie gelesen haben: Identifizieren Sie die Seite stattdessen über id oder slug, beide werden weiterhin zurückgegeben.

Häufige Fehler

  • 400 Bad Request (invalidRequestBody), wenn historyPage keine ganze Zahl von 1 bis 400 ist
  • 404 Not found (statusPageNotFound), wenn die Statusseite nicht existiert, nicht veröffentlicht ist (außer in der oben beschriebenen Vorschau) oder ihre Organisation gesperrt (Zahlungssperre oder von uns gesperrt; eine Organisation, deren Monitoring nur endete, bleibt online), gelöscht ist oder das Statusseiten-Modul ausgeschaltet hat
  • 403 Forbidden bei customer_members_only-Seiten, wenn der Nutzer kein Mitglied ist
  • 401 Unauthorized (passwordRequired) bei password_protected-Seiten ohne gültiges Zugriffs-Cookie (siehe verify-password oben)
  • 401 Unauthorized (ssoRequired) bei sso_members_only-Seiten, wenn der Besucher nicht oder ohne das Single Sign-on der Organisation angemeldet ist
  • 403 Forbidden (statusPageIpNotAllowed), wenn die Seite eine IP-Freigabeliste hat und die Anfrage aus einem anderen Netz kommt

Auf dieser Seite