Deutsch English

Verlaufseintrag veröffentlichen

POST /api/v1/incidents/{incident}/updates

Enthält den neuen Status, die Notiz und optional geänderte Komponenten-Auswirkungen; benachrichtigt die Abonnenten mit diesem Text. Ein Endstatus schließt den Vorfall.

Erforderliche Berechtigung

incidents.manage Vorfälle und Wartungen verwalten

URL Variablen

Name Beschreibung
incident Numerische ID des Vorfalls oder Wartungsfensters. Beide Sammlungen liegen auf einem Modell — deshalb heißt der Platzhalter auch auf den Wartungs-Routen {incident}.

Body Parameter (application/json)

Name Format Beschreibung Optional
status Status, die ein VORFALL annehmen kann (IncidentStatus::forType). —
body Mehrsprachiger Text als Objekt je Sprache, z. B. {"de": "…", "en": "…"}. Ein einfacher String wird in der Hauptsprache der Statusseite gespeichert. Bei PATCH partiell: eine weggelassene Sprache bleibt unverändert, ein ausdrückliches null löscht sie. —
components Betroffene Komponenten als Liste von Objekten: {"id": <int>, "impact": "operational|degraded|partial_outage|major_outage|under_maintenance"}. Geänderte Auswirkungen, angewendet bevor die Benachrichtigung rausgeht.
posted_at String
notify Boolean

Beispiel-Request (application/json) 

{
  "status": "investigating",
  "body": {
    "de": "Wir untersuchen erhöhte Latenzen.",
    "en": "We are investigating elevated latencies."
  },
  "components": [
    {
      "id": 3,
      "impact": "degraded"
    }
  ],
  "posted_at": "2026-07-27T14:20:00Z",
  "notify": true
}

Werte sind Beispiele — Pflichtfelder stehen in der Tabelle. Der Body wird als JSON gesendet.

Response (application/json) 

{1 Eigenschaft
  "data": {6 Eigenschaften
    "id": 41,
    "incident_id": 12,
    "status": "monitoring",
    "body": {2 Eigenschaften
      "de": "Ursache gefunden, wir beobachten.",
      "en": "Cause identified, monitoring."
    },
    "posted_at": "2026-07-27T14:20:00Z",
    "created_at": "2026-07-27T14:20:00Z"
  }
}
{2 Eigenschaften
  "message": "Incident not found.",
  "documentation_url": "https://docs.firestatus.de"
}
{2 Eigenschaften
  "message": "This API accepts JSON only. Send the request body as application/json (received application/x-www-form-urlencoded).",
  "documentation_url": "https://docs.firestatus.de"
}
{3 Eigenschaften
  "message": "The body field must be filled in at least one language (de, en).",
  "errors": {1 Eigenschaft
    "body": [1 Element
      "The body field must be filled in at least one language (de, en)."
    ]
  },
  "documentation_url": "https://docs.firestatus.de"
}

cURL

curl -X POST 'https://status.example.com/api/v1/incidents/{incident}/updates' \
  -H 'Authorization: Bearer fs_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"status":"investigating","body":{"de":"Wir untersuchen erhöhte Latenzen.","en":"We are investigating elevated latencies."},"components":[{"id":3,"impact":"degraded"}],"posted_at":"2026-07-27T14:20:00Z","notify":true}'