Wartungsfenster aktualisieren
PUT
/api/v1/maintenances/{incident}
Partiell wie bei Vorfällen. Ein verschobener Start aktiviert die „beginnt bald"-Erinnerung erneut.
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 |
|---|---|---|---|
| title | 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. | ||
| 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. | ||
| status | Status, die ein WARTUNGSFENSTER annehmen kann (IncidentStatus::forType). | ||
| started_at | String | ||
| components | Betroffene Komponenten als Liste von Objekten: {"id": <int>, "impact": "operational|degraded|partial_outage|major_outage|under_maintenance"}. Ersetzt die komplette Liste. Weglassen, um die Auswirkungen unverändert zu lassen. | ||
| scheduled_end_at | String |
Beispiel-Request (application/json)
{
"title": {
"de": "Störung im Netz",
"en": "Network issue"
},
"body": {
"de": "Wir untersuchen erhöhte Latenzen.",
"en": "We are investigating elevated latencies."
},
"status": "scheduled",
"started_at": "2026-07-27T13:55:00Z",
"components": [
{
"id": 3,
"impact": "degraded"
}
],
"scheduled_end_at": "2026-08-02T02:00:00Z"
}
Werte sind Beispiele — Pflichtfelder stehen in der Tabelle. Der Body wird als JSON gesendet.
Response (application/json)
{1 Eigenschaft
"data": {20 Eigenschaften
"id": 12,
"type": "incident",
"status": "investigating",
"title": {2 Eigenschaften
"de": "Störung im Netz",
"en": "Network issue"
},
"body": {2 Eigenschaften
"de": "Wir untersuchen erhöhte Latenzen.",
"en": null
},
"started_at": "2026-07-27T13:55:00Z",
"scheduled_end_at": null,
"published_at": "2026-07-27T14:00:00Z",
"publish_at": "2026-07-27T14:00:00Z",
"resolved_at": null,
"acknowledged_at": null,
"is_published": true,
"is_scheduled": false,
"is_resolved": false,
"components": [1 Element
{2 Eigenschaften
"id": 3,
"impact": "degraded"
}
],
"public_url": "https://status.example.com/incidents/12",
"postmortem": null,
"updates": [],
"created_at": "2026-07-27T14:00:00Z",
"updated_at": "2026-07-27T14:00:00Z"
}
}
{2 Eigenschaften
"message": "Maintenance 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"
}
cURL
curl -X PUT 'https://status.example.com/api/v1/maintenances/{incident}' \
-H 'Authorization: Bearer fs_YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"title":{"de":"Störung im Netz","en":"Network issue"},"body":{"de":"Wir untersuchen erhöhte Latenzen.","en":"We are investigating elevated latencies."},"status":"scheduled","started_at":"2026-07-27T13:55:00Z","components":[{"id":3,"impact":"degraded"}],"scheduled_end_at":"2026-08-02T02:00:00Z"}'