Statusseiten-Regeln

GET /api/im/statuspage-rules · POST /api/im/statuspage-rules · PATCH /api/im/statuspage-rules/:id · DELETE /api/im/statuspage-rules/:id · POST /api/im/statuspage-rules/override · DELETE /api/im/statuspage-rules/override/:statusPageId

Eine Statusseiten-Regel bedeutet: „Incidents von Team X mit Severity minSeverity oder schwerer setzen Statusseite Y auf targetState." sev1 ist die schwerste Stufe. Mit autoResolve wird der Zustand der Seite zurückgesetzt, sobald der Incident gelöst ist. Eine manuelle Übersteuerung setzt einen Zustand auf einer Statusseite von Hand. Solange eine manuelle Übersteuerung aktiv ist, ändern und löschen Regeln den Zustand dieser Seite nicht.

AuthentifizierungAnkerlink kopieren

Erfordert den Basiszugriff auf Incident Management, den jeder Endpunkt dieser API braucht (eine IM-berechtigte Rolle admin, editor oder responder, oder ein organisationsweites API-Token; Incident Management muss für die Organisation aktiviert sein). Regeln auflisten darf jede IM-berechtigte Rolle.

• Regeln anlegen, ändern und löschen erfordert die Schreibhürde: Deine Rolle muss admin sein, oder du musst Team-Admin des Teams der Regel sein.
• Eine manuelle Übersteuerung setzen oder aufheben erfordert die Rolle admin oder editor, dieselbe Hürde wie andere Änderungen an Statusseiten.

Ein organisationsweites API-Token läuft mit der Rolle der Person, die es erstellt hat. Eine Team-Admin-Mitgliedschaft gilt für ein Token nie.

Regeln auflistenAnkerlink kopieren

GET /api/im/statuspage-rules

Liefert alle Regeln deiner Organisation, sortiert nach id.

Beispiel (cURL)Ankerlink kopieren

curl -X GET "$BASE_URL/api/im/statuspage-rules" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Antwort (Response)Ankerlink kopieren

200 OK

[
  {
    "id": 2,
    "organizationId": 1,
    "teamId": 3,
    "statusPageId": 15,
    "minSeverity": "sev2",
    "targetState": "degraded",
    "autoResolve": true,
    "createdAt": "2026-09-25T09:00:00.000Z",
    "updatedAt": "2026-09-25T09:00:00.000Z"
  }
]

Regel anlegenAnkerlink kopieren

POST /api/im/statuspage-rules

Request BodyAnkerlink kopieren

Beispiel (cURL)Ankerlink kopieren

curl -X POST "$BASE_URL/api/im/statuspage-rules" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "teamId": 3, "statusPageId": 15, "minSeverity": "sev2", "targetState": "degraded" }'

Antwort (Response)Ankerlink kopieren

200 OK: die angelegte Regel (gleiche Form wie ein Listeneintrag).

Regel ändernAnkerlink kopieren

PATCH /api/im/statuspage-rules/:id

Teilweise Aktualisierung von teamId, statusPageId, minSeverity, targetState und autoResolve (gleiche Validierung wie beim Anlegen). Andere Schlüssel werden ignoriert. Du brauchst die Schreibhürde für das aktuelle Team der Regel und, wenn du teamId änderst, auch für das neue Team.

curl -X PATCH "$BASE_URL/api/im/statuspage-rules/2" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "minSeverity": "sev1", "targetState": "warning" }'

200 OK: die aktualisierte Regel.

Regel löschenAnkerlink kopieren

DELETE /api/im/statuspage-rules/:id

curl -X DELETE "$BASE_URL/api/im/statuspage-rules/2" \
  -H "Authorization: Bearer $TOKEN"

200 OK

{ "ok": true }

Manuelle Übersteuerung setzenAnkerlink kopieren

POST /api/im/statuspage-rules/override

Setzt einen Zustand auf einer Statusseite und benachrichtigt ihre Abonnenten. Ersetzt jede Übersteuerung, die gerade auf der Seite liegt, egal ob eine Regel oder eine Person sie gesetzt hat.

curl -X POST "$BASE_URL/api/im/statuspage-rules/override" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "statusPageId": 15, "state": "warning", "message": "E-Mails kommen verzögert an, wir sind dran." }'

200 OK

{ "ok": true }

Übersteuerung aufhebenAnkerlink kopieren

DELETE /api/im/statuspage-rules/override/:statusPageId

Entfernt die aktuelle Übersteuerung von der Seite, egal ob eine Regel oder eine Person sie gesetzt hat. Die Seite folgt danach wieder den Regeln (oder, ohne aktive Regel, ihren Monitoren). War eine Übersteuerung aktiv, werden die Abonnenten benachrichtigt.

curl -X DELETE "$BASE_URL/api/im/statuspage-rules/override/15" \
  -H "Authorization: Bearer $TOKEN"

200 OK

{ "ok": true }

Häufige FehlerAnkerlink kopieren

• 401 Unauthorized wenn du nicht authentifiziert bist
• 403 Forbidden (imAccessDenied) bei Verwendung eines kunden-gescopten Tokens, oder wenn deine Session keine IM-berechtigte Rolle hat
• 403 Forbidden (imNotEnabled) wenn Incident Management für die Organisation nicht aktiviert ist
• 403 Forbidden (imTeamWriteDenied) wenn du die Schreibhürde für das Team der Regel (oder das neue Team) nicht erfüllst
• 403 Forbidden (ohne data.code) wenn du eine Übersteuerung ohne die Rolle admin oder editor setzt oder aufhebst
• 400 Bad Request (invalidRequestBody) wenn :id oder :statusPageId keine positive Ganzzahl ist, teamId oder statusPageId fehlt oder ungültig ist, minSeverity, targetState oder state keinen erlaubten Wert hat, oder autoResolve kein Boolean ist
• 404 Not Found (imStatuspageRuleNotFound) wenn die Regel nicht existiert oder zu einer anderen Organisation gehört
• 422 Unprocessable Entity (invalidTeamId) wenn teamId nicht zu deiner Organisation gehört
• 422 Unprocessable Entity (invalidStatusPageId) wenn statusPageId nicht zu deiner Organisation gehört