Statusseiten-Text aktualisieren

POST /api/im/incidents/:id/statuspage-update

Setzt den kuratierten Text, den Statusseiten für diesen Incident zeigen (statuspageUpdate am Incident). Statusseiten, die eine Statusseiten-Regel wegen dieses Incidents gerade umgeschaltet hat, zeigen den neuen Text sofort. Hat sich der Text tatsächlich geändert, erhalten die Abonnenten dieser Seiten ein Incident-Update. Ob überhaupt eine Regel für den Incident greift, meldet Incident abrufen als statuspageRuleApplies; ohne passende Regel wird der Text gespeichert, erscheint aber nirgends. Die Änderung landet im IM-Audit-Log.

AuthentifizierungAnkerlink kopieren

Erfordert IM-Zugriff, siehe Authentifizierung, und Schreibrechte für Statusseiten: Rolle admin oder editor. Ein responder kann diesen Endpunkt nicht nutzen. Ein organisationsweiter API-Token gilt dabei als Organisations-Admin. Incident Management muss für die Organisation aktiviert sein. Es gibt keine Team-Einschränkung.

Anfrage (Request Body)Ankerlink kopieren

Beispiel (cURL)Ankerlink kopieren

curl -X POST "$BASE_URL/api/im/incidents/42/statuspage-update" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "update": "We are investigating slow logins. Next update in 30 minutes." }'

Antwort (Response)Ankerlink kopieren

200 OK: der Text, wie er gespeichert wurde.

{
  "ok": true,
  "statuspageUpdate": "We are investigating slow logins. Next update in 30 minutes."
}

Häufige FehlerAnkerlink kopieren

• 401 Unauthorized wenn du nicht authentifiziert bist
• 403 Forbidden (customerScopedTokenForbidden) bei Verwendung eines kunden-gescopten Tokens
• 403 Forbidden (imAccessDenied) wenn die angemeldete Person keine IM-berechtigte Rolle hat
• 403 Forbidden (imNotEnabled) wenn Incident Management für die Organisation nicht aktiviert ist
• 403 Forbidden (ohne data.code) wenn deine Rolle weder admin noch editor ist
• 400 Bad Request (invalidRequestBody) wenn :id keine positive Ganzzahl ist, oder update fehlt oder weder String noch null ist
• 404 Not Found (imIncidentNotFound) wenn der Incident nicht existiert oder zu einer anderen Organisation gehört