Incident Management

Incident Management (IM) ist eine von Monitoring getrennte Domäne: ein zweistufiges Alert-/Incident-Modell mit Teams, On-Call-Zeitplänen und Eskalations-Tiers. Dieser Abschnitt beschreibt die öffentlichen REST-Endpunkte zum Einspeisen von Alerts und zum programmatischen Verwalten von Incidents.

AuthentifizierungAnkerlink kopieren

Fast jeder der folgenden Endpunkte akzeptiert einen organisationsweiten API-Token. Drei Ausnahmen: Mein Bereitschaftsstatus, die persönlichen Benachrichtigungseinstellungen und der Test-Alarm der Einrichtung beschreiben eine Person und brauchen eine Benutzersitzung; der Ingest-Webhook authentifiziert sich stattdessen über den Token in seiner URL.

Mit einem API-Token:

BASE_URL="https://uptimeify.io"
TOKEN="wsm_<dein-organisationsweiter-api-token>"

Erstelle einen über Organisations-Token erstellen und lasse customerId dabei weg. Ein Token, der mit einer customerId erstellt wurde (ein kunden-gescopter Token), wird auf jedem IM-Pfad mit 403 Forbidden (customerScopedTokenForbidden) abgelehnt; Incident Management hat bewusst keine kundenseitige Oberfläche.

Incident Management muss außerdem für deine Organisation aktiviert sein, sonst liefert jeder der folgenden Endpunkte 403 Forbidden (imNotEnabled).

Ein organisationsweiter Token handelt mit der aktuellen Rolle der Person, die ihn erstellt hat, gelesen bei jeder Anfrage. Organisations-Token können nur Organisations-Admins erstellen, ein Token handelt also normalerweise als admin und besteht jede Team-Prüfung in diesem Abschnitt (etwa „Mitglied im Team des Incidents"). Wird die Person später zu editor oder responder herabgestuft, behält der Token deren Zugriff und verliert die Admin-Schreibrechte. Wird sie readonly, deaktiviert oder gelöscht, verliert der Token den Zugang zu Incident Management ganz (403 imAccessDenied).

Ein Token ist keine Person. Änderungen über ihn werden ohne Person vermerkt: createdBy, acknowledgedBy und resolvedBy am Incident sowie actorUserId an seinen Timeline-Events bleiben null, wie bei einem Systemereignis.

EndpunkteAnkerlink kopieren

EinstiegAnkerlink kopieren

• Incident Management aktivieren: POST /api/im/activate
• Einrichtungsstand und Test-Alarm: GET/PATCH /api/im/setup/state, POST /api/im/setup/test-page

Alerts und BereitschaftAnkerlink kopieren

• Events Ingest: POST /api/im/events
• Ingest-Webhook: POST /api/im/ingest/:token
• Wer hat Bereitschaft: GET /api/im/on-call
• Mein Bereitschaftsstatus: GET /api/im/me/on-call, GET /api/im/me/on-call-stats
• Persönliche Benachrichtigungseinstellungen: /api/im/notification-settings/**
• Benachrichtigungen einer Person: /api/im/users/:userId/notification-settings (Admin)
• Standard-Benachrichtigung: /api/im/notification-template (Admin)

IncidentsAnkerlink kopieren

• Incidents auflisten: GET /api/im/incidents
• Offene Incidents zählen: GET /api/im/incidents/count
• Incident abrufen: GET /api/im/incidents/:id
• Incident zu einem Monitoring-Incident finden: GET /api/im/incidents/by-monitor/:id
• Incident erstellen: POST /api/im/incidents
• Incident bestätigen / Status ändern: POST /api/im/incidents/:id/ack und POST /api/im/incidents/:id/status
• Incident lösen: POST /api/im/incidents/:id/resolve
• Schweregrad ändern: POST /api/im/incidents/:id/severity
• Incident schlummern lassen: POST /api/im/incidents/:id/snooze
• Sofort eskalieren: POST /api/im/incidents/:id/escalate-now
• Incident-Rollen zuweisen: POST /api/im/incidents/:id/assign und POST /api/im/incidents/:id/add-responder
• Incident kommentieren: POST /api/im/incidents/:id/comment
• Incidents zusammenführen: POST /api/im/incidents/:id/merge
• Statusseiten-Text aktualisieren: POST /api/im/incidents/:id/statuspage-update
• Incidents gesammelt ändern: POST /api/im/incidents/bulk

Teams und ZeitpläneAnkerlink kopieren

• Teams
• Team-Mitglieder
• Eskalations-Tiers
• Team-Overrides
• Team-Einblicke
• Schedules
• Schedule bearbeiten
• Schedule-Overrides

Alert-Sources und KonfigurationAnkerlink kopieren

• Alert-Sources
• Routing-Regeln
• Kanäle
• Ausgehende Integrationen
• Statusseiten-Regeln
• Organisationseinstellungen

AuswertungenAnkerlink kopieren

• Analytics
• Audit-Log
• Berichte

Alert-Source-EinrichtungsanleitungenAnkerlink kopieren

Möchtest du Alarme lieber aus einem bestehenden Monitoring-Tool senden, statt die API direkt aufzurufen? Die Alert-Source-Einrichtungsanleitungen enthalten Schritt-für-Schritt-Anleitungen für Zabbix, Datadog, Grafana Alerting, Prometheus Alertmanager, Sentry und jeden benutzerdefinierten Webhook. Jede Source hat ihre eigene Ingest-URL, die statt eines API-Tokens ein geheimes Token enthält, getrennt vom oben genannten Events-Ingest-Endpunkt.

FehlercodesAnkerlink kopieren

Siehe Fehlerliste und bekannte API-Fallen für die vollständige Liste der data.code-Werte, die diese Endpunkte liefern können.