Deutsch English

Wartungsfenster anlegen

POST /api/v1/maintenances

Beide Enden des Wartungsfensters sind erforderlich.

Erforderliche Berechtigung

incidents.manage Vorfälle und Wartungen verwalten

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 WARTUNGSFENSTER annehmen kann (IncidentStatus::forType).
components string Liste betroffener Komponenten als JSON-Array, je Eintrag {"id": 3, "impact": "degraded"}. Erlaubte Auswirkungen: degraded, partial_outage, major_outage, under_maintenance.
started_at string Wann der Vorfall tatsächlich begann; darf vor dem Datensatz liegen. —
publish
publish_at string Erforderlich bei publish=schedule; muss in der Zukunft liegen.
notify boolean Wird nur ausgewertet, wenn tatsächlich veröffentlicht wird.
scheduled_end_at string —

Response (application/json) 

{1 Eigenschaft
  "data": {19 Eigenschaften
    "id": 13,
    "type": "maintenance",
    "status": "scheduled",
    "title": {2 Eigenschaften
      "de": "Datenbank-Wartung",
      "en": "Database maintenance"
    },
    "body": {2 Eigenschaften
      "de": "Kurze Unterbrechungen möglich.",
      "en": null
    },
    "started_at": "2026-08-02T00:00:00Z",
    "scheduled_end_at": "2026-08-02T02:00:00Z",
    "published_at": null,
    "publish_at": null,
    "resolved_at": null,
    "acknowledged_at": null,
    "is_published": false,
    "is_scheduled": false,
    "is_resolved": false,
    "components": [1 Element
      {2 Eigenschaften
        "id": 4,
        "impact": "under_maintenance"
      }
    ],
    "public_url": null,
    "updates": [],
    "created_at": "2026-07-27T14:00:00Z",
    "updated_at": "2026-07-27T14:00:00Z"
  }
}
{2 Eigenschaften
  "message": "The scheduled end at field must be a date after started at.",
  "errors": {1 Eigenschaft
    "scheduled_end_at": [1 Element
      "The scheduled end at field must be a date after started at."
    ]
  }
}

cURL

curl -X POST 'https://status.example.com/api/v1/maintenances' \
  -H 'Authorization: Bearer fs_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"VALUE","body":"VALUE","status":"VALUE","components":"VALUE","started_at":"VALUE","publish":"VALUE","publish_at":"VALUE","notify":"VALUE","scheduled_end_at":"VALUE"}'