Organisationseinstellungen
Die Incident-Management-Einstellungen deiner Organisation lesen und ändern: Monitoring-Brücke, SMS/Anruf-Mehrverbrauch und Fallback-Kanal.
GET /api/im/org-settings · PATCH /api/im/org-settings
Die Incident-Management-Einstellungen deiner Organisation. Beide Endpunkte funktionieren auch, solange Incident Management noch nicht aktiviert ist; so kannst du den Stand prüfen und die Konfiguration vor der Aktivierung vorbereiten. Die Aktivierung selbst erfolgt im Dashboard, nicht über diesen Endpunkt.
Authentifizierung
Erfordert eine IM-berechtigte Rolle (admin, editor oder responder) oder ein organisationsweites API-Token. Anders als beim Rest dieser API muss Incident Management nicht aktiviert sein. Lesen darf jede IM-berechtigte Rolle. Ändern erfordert die Rolle admin. Ein organisationsweites API-Token läuft mit der Rolle der Person, die es erstellt hat.
Einstellungen abrufen
GET /api/im/org-settings
Beispiel (cURL)
curl -X GET "$BASE_URL/api/im/org-settings" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json"Antwort (Response)
200 OK
{
"organizationId": 1,
"enabled": true,
"overageEnabled": false,
"monitoringBridge": "both",
"fallbackChannelId": 10,
"fallbackChannel": null
}| Feld | Beschreibung |
|---|---|
enabled | Ob Incident Management aktiv ist. Hier nur lesbar. |
overageEnabled | Ob SMS- und Anruf-Benachrichtigungen über das enthaltene Kontingent hinaus weiterlaufen dürfen (kostenpflichtig). Standard false. |
monitoringBridge | Wie Monitoring-Incidents mit Incident Management zusammenhängen. both (Standard): Monitoring-Incidents öffnen auch IM-Incidents, klassische Alarme gehen weiter raus. im_only: Monitoring-Incidents öffnen IM-Incidents, klassische Alarme werden unterdrückt. classic_only: keine Brücke, nur klassische Alarme. |
fallbackChannelId | ID des Kanals, der benachrichtigt wird, wenn einer Eskalation die Stufen ausgehen, oder null. |
fallbackChannel | Altfeld, nur lesbar, ohne Wirkung. Nutze fallbackChannelId. |
Einstellungen ändern
PATCH /api/im/org-settings
Teilweise Aktualisierung. Mindestens ein Feld ist nötig; jeder andere Schlüssel ergibt 400.
Request Body
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
overageEnabled | boolean | Nein | SMS/Anrufe über das enthaltene Kontingent hinaus erlauben. |
monitoringBridge | string | Nein | im_only, classic_only oder both. |
fallbackChannelId | integer | null | Nein | Ein aktiver Kanal deiner Organisation, oder null zum Entfernen. |
enabled lässt sich hier nicht setzen, und das Altfeld fallbackChannel wird abgelehnt.
Beispiel (cURL)
curl -X PATCH "$BASE_URL/api/im/org-settings" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ "fallbackChannelId": 10, "monitoringBridge": "im_only" }'Antwort (Response)
200 OK: die aktualisierten Einstellungen, in derselben Form wie die GET-Antwort.
Häufige Fehler
401 Unauthorizedwenn du nicht authentifiziert bist403 Forbidden(imAccessDenied) bei Verwendung eines kunden-gescopten Tokens, oder wenn deine Session keine IM-berechtigte Rolle hat403 Forbidden(forbidden) wenn du ohne die Rolleadminändern willst400 Bad Request(invalidRequestBody) wenn der Body leer ist oder einen nicht unterstützten Schlüssel enthält (auchenabled),overageEnabledkein Boolean ist,monitoringBridgekeinen erlaubten Wert hat, oderfallbackChannelIdweder eine positive Ganzzahl nochnullnoch ein Kanal deiner Organisation ist400 Bad Request(imChannelInactive) wennfallbackChannelIdauf einen inaktiven Kanal zeigt400 Bad Request(imFallbackChannelDeprecated) wenn der BodyfallbackChannelenthält
Wer hat Bereitschaft
Liefert, wer gerade Bereitschaft hat, ein Eintrag pro Schedule deiner Organisation.
Ausgehende Integrationen
Incident-Management-Ereignisse an Slack, Microsoft Teams, Discord, Jira, PagerDuty, Opsgenie oder einen generischen Webhook weiterleiten, Zustellungen einsehen und erneut senden.