Skip to Content
Uptimeify Docs

Statusseiten auflisten

Gibt alle Statusseiten der Organisation zurück. Jede Seite enthält ihre Custom-Domain-Infos, sofern konfiguriert.

GET /api/status-pages

Query-Parameter

ParameterTypStandardBeschreibung
envelopestringkeineritems: Antwort als { items, total, page, perPage }. Ab 18.01.2027 Standard.

Beispiel (cURL)

curl -X GET "$BASE_URL/api/status-pages?envelope=items" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Antwort

{
  "items": [
    {
      "id": 1,
      "publicId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "organizationId": 1,
      "customerId": 5,
      "includeCustomerMonitors": true,
      "managementType": "managed",
      "canEdit": true,
      "customerPublicId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
      "name": "Production Status",
      "slug": "production-status",
      "description": "Real-time status of our production services",
      "visibility": "public",
      "isPublished": true,
      "showRecentIncidents": true,
      "showRecentMaintenance": true,
      "customDomainId": null,
      "ipAllowlist": [],
      "audienceGroups": [],
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-15T10:00:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "perPage": 1
}

Listenform: Mit envelope=items kommt die Liste als { items, total, page, perPage }. Ohne den Parameter antwortet der Endpunkt noch in der bisherigen Form ({ "statusPages": [...] }); sie ist veraltet, ab dem 18.01.2027 ist { items, ... } der Standard.

customerId, customerPublicId und customerName sind bei einer Seite ohne Kunde null. Eine solche Seite sehen nur organisationsweite Rollen und API-Token; ein kundengebundener Aufrufer sieht sie nicht. includeCustomerMonitors sagt, ob die Monitore des Kunden automatisch erscheinen. Die Komponenten einer Seite liest du mit Komponenten auflisten und Komponentengruppen auflisten.

canEdit (seit 30. Oktober 2026) sagt, ob du diese Seite und was an ihr hängt ändern darfst (Einstellungen, Komponenten, eigene Domain, Abonnenten, Vorfälle, Wartungen). Organisationsweite Aufrufer: true mit der Rolle admin oder editor. Kundengebundene Nutzer und Tokens (auch mit der Rolle readonly): true für self_service-Seiten, für managed-Seiten nur, wenn der Kunde canEditManaged hat. Es ist dieselbe Regel, die die schreibenden Endpunkte anwenden, siehe Wer eine Statusseite ändern darf.

ipAllowlist und audienceGroups (seit 28. Oktober 2026) enthalten die IP-Freigabeliste der Seite (als addr/prefix) und ihre Zielgruppen (name, emailDomains, componentIds als numerische IDs); ohne Einstellung sind beide [].

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

Auf dieser Seite