Uptimeify Docs

Incident zu einem Monitoring-Incident finden

Ermittelt zu einer Monitoring-Incident-ID den Incident-Management-Incident, in den er übernommen wurde.

GET /api/im/incidents/by-monitor/:id

Ist die Monitoring-Brücke eingeschaltet (siehe Organisationseinstellungen), wird jeder Incident aus Uptimeifys eigenem Monitoring zu einem Alarm in Incident Management und dort einem Incident zugeordnet. Dieser Endpunkt beantwortet, in welchem Incident-Management-Incident ein bestimmter Monitoring-Incident gelandet ist, etwa um von einem Monitoring-Incident auf seine Alarmierung und Timeline zu verlinken.

Es zählen nur Alarme der organisationseigenen Monitoring-Quelle. Ein eigener Webhook, der zufällig denselben Dedup-Schlüssel (monitor:<id>) sendet, wird nie getroffen. Wurde der Monitoring-Incident mehrfach übernommen, gewinnt der neueste Alarm.

Authentifizierung

Jede IM-berechtigte Rolle (admin, editor, responder) oder ein organisationsweiter API-Token, siehe Authentifizierung. Incident Management muss für die Organisation aktiviert sein.

Pfadparameter

ParameterTypBeschreibung
idnumberDie ID des Monitoring-Incidents, wie sie Incidents auflisten der Monitoring-API liefert.

Beispiel (cURL)

curl -X GET "$BASE_URL/api/im/incidents/by-monitor/5123" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Antwort (Response)

{
  "incidentId": 1834
}

Den Incident selbst lädst du mit Incident abrufen.

Häufige Fehler

  • 400 Bad Request (invalidRequestBody) wenn id keine positive Zahl ist
  • 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 (imNotEnabled) wenn Incident Management für die Organisation nicht aktiviert ist
  • 404 Not Found (imIncidentNotFound) wenn der Monitoring-Incident (noch) nicht übernommen wurde oder zu einer anderen Organisation gehört

Auf dieser Seite