Uptimeify Docs

Komponente aktualisieren

Ändert Name, Beschreibung, Gruppe, Position, Verfügbarkeitsbalken oder manuellen Zustand einer Komponente.

PATCH /api/status-pages/{id}/components/{componentId}

Zugriff

Organisations-admin und editor. Ein kundengebundener Nutzer oder API-Token erreicht nur Seiten eines Kunden in seinem Bereich; eine Seite ohne Kunde (customerId: null) beantwortet ihm 403 (forbidden). Eine Seite einer anderen Organisation antwortet 404 (statusPageNotFound). IDs im Pfad nehmen die numerische ID oder die publicId. Die Änderung steht im Audit-Protokoll der Organisation.

Request-Body (alle optional, mindestens ein Feld)

FeldTypBeschreibung
namestringAnzeigename (1-120 Zeichen).
descriptionstring|nullMax. 1000 Zeichen. null löscht sie.
groupIdnumber|string|nullID oder publicId einer Gruppe dieser Seite. null nimmt die Komponente aus ihrer Gruppe.
sortnumberPosition, 0-100000.
showUptimebooleanVerfügbarkeitsbalken anzeigen.
manualStatusstringNur manuelle Komponenten: operational, degraded, partial_outage, major_outage oder maintenance.

sourceKind und der Monitor einer Komponente lassen sich nicht ändern; lösche die Komponente und lege eine neue an. Um viele Komponenten auf einmal zu verschieben, nimm Komponenten sortieren.

Beispiel (cURL)

BASE_URL="https://uptimeify.io"
TOKEN="<dein-api-token>"

curl -X PATCH "$BASE_URL/api/status-pages/1/components/8" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "manualStatus": "partial_outage" }'

Antwort

200 OK mit der geänderten Komponente, in derselben Form wie bei Komponenten auflisten.

Häufige Fehler

  • 400 Bad Request (invalidRequestBody), wenn der Body leer oder ein Feld ungültig ist
  • 400 Bad Request (statusPageComponentNotManual), wenn manualStatus für eine Monitor-Komponente gesendet wird
  • 400 Bad Request (invalidIdentifier), wenn eine ID im Pfad weder Zahl noch UUID ist
  • 401 Unauthorized, wenn du nicht angemeldet bist
  • 403 Forbidden (forbidden), wenn deine Rolle das nicht darf, oder für einen kundengebundenen Aufrufer auf einer Seite ohne Kunde oder eines anderen Kunden
  • 403 Forbidden (statusPagesModuleDisabled), wenn das Statusseiten-Modul nicht aktiviert ist
  • 404 Not Found (statusPageNotFound), wenn die Status-Seite nicht existiert oder zu einer anderen Organisation gehört
  • 404 Not Found (statusPageComponentNotFound), wenn es die Komponente auf dieser Seite nicht gibt
  • 404 Not Found (statusPageComponentGroupNotFound), wenn groupId keine Gruppe dieser Seite ist

Auf dieser Seite