Incident Management aktivieren

POST /api/im/activate

Schaltet Incident Management für deine Organisation ein. Solange das nicht geschehen ist, antwortet jeder andere Endpunkt dieser API mit 403 und imNotEnabled; dieser hier (und der Einrichtungsstand) ist absichtlich schon vor der Aktivierung erreichbar.

Die Aktivierung ist idempotent. Bei einer bereits aktivierten Organisation liefert sie alreadyEnabled: true und ändert nichts. Bei der ersten Aktivierung führt Uptimeify zusätzlich seine Aktivierungs-Hooks aus, zum Beispiel die Übernahme offener Monitoring-Incidents in Incident Management, wenn die Monitoring-Brücke eingeschaltet ist. Schlägt ein Hook fehl, bleibt die Aktivierung trotzdem bestehen; sein Name steht dann in hookErrors.

AuthentifizierungAnkerlink kopieren

Erfordert eine IM-berechtigte Rolle und Schreibrechte an der Organisation: die Rolle admin dieser Organisation oder einen organisationsweiten API-Token, den ein Organisations-Admin erstellt hat. editor und responder erhalten 403 (forbidden).

Query-ParameterAnkerlink kopieren

Beispiel (cURL)Ankerlink kopieren

curl -X POST "$BASE_URL/api/im/activate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Antwort (Response)Ankerlink kopieren

Erste Aktivierung:

{
  "organizationId": 42,
  "enabled": true,
  "monitoringBridge": true,
  "alreadyEnabled": false,
  "hookErrors": []
}

Bereits aktiviert:

{
  "organizationId": 42,
  "enabled": true,
  "monitoringBridge": true,
  "alreadyEnabled": true
}

Häufige FehlerAnkerlink kopieren

• 400 Bad Request (organizationIdRequired) wenn sich keine Organisation bestimmen lässt
• 401 Unauthorized wenn du nicht authentifiziert bist
• 403 Forbidden (customerScopedTokenForbidden) bei Verwendung eines kunden-gescopten Tokens
• 403 Forbidden (imAccessDenied) wenn keine IM-berechtigte Rolle vorliegt
• 403 Forbidden (forbidden) wenn du kein Admin der Organisation bist