Deutsch English

Vorfall aktualisieren

PATCH /api/v1/incidents/:incident

Nur Stammdaten. published_at, publish_at und resolved_at sind hier NICHT schreibbar — dafür gibt es die Lebenszyklus-Endpunkte.

Erforderliche Berechtigung

incidents.manage Vorfälle und Wartungen verwalten

URL Variablen

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

Body Parameter (application/json)

Name Format Beschreibung Optional
title string Locale-Objekt, z. B. {"de": "Störung", "en": "Outage"}. Bei PATCH partiell; ein explizites null löscht die Übersetzung.
body string Locale-Objekt wie bei title. Markdown erlaubt.
status Status, die ein VORFALL annehmen kann (IncidentStatus::forType).
started_at string
components string Liste betroffener Komponenten als JSON-Array, je Eintrag {"id": 3, "impact": "degraded"}. Erlaubte Auswirkungen: degraded, partial_outage, major_outage, under_maintenance.

Response (application/json) 

{1 Eigenschaft
  "data": {19 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",
    "updates": [],
    "created_at": "2026-07-27T14:00:00Z",
    "updated_at": "2026-07-27T14:00:00Z"
  }
}
{1 Eigenschaft
  "message": "Incident not found."
}
{2 Eigenschaften
  "message": "The title must remain filled in at least one language.",
  "errors": {1 Eigenschaft
    "title": [1 Element
      "The title must remain filled in at least one language."
    ]
  }
}

cURL

curl -X PATCH 'https://status.example.com/api/v1/incidents/:incident' \
  -H 'Authorization: Bearer fs_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"VALUE","body":"VALUE","status":"VALUE","started_at":"VALUE","components":"VALUE"}'