Uptimeify Docs

Design aktualisieren

Aktualisiert die visuelle Designkonfiguration einer Status-Seite. Es werden nur die übermittelten Felder geändert. Alle anderen Einstellungen bleiben unverändert. Erfordert Admin-Rolle.

PATCH /api/status-pages/:id/design

Pfad-Parameter

ParameterBeschreibung
idStatus-Seiten-ID oder publicId (UUID)

Request Body (alle Felder optional)

Layout

FeldTypWerteStandardBeschreibung
layoutstringstatusboard classic cards minimal sleek board split timeline compactstatusboardVisuelles Layout-Template. statusboard ist die Vorgabe für Statusseiten, die ab dem 7. September 2026 angelegt werden; ältere Seiten behalten ihr bisheriges Layout.
pageWidthstringsm md lg xllgMaximale Inhaltsbreite: sm = 672 px, md = 896 px, lg = 1024 px, xl = 1280 px

Farben

FeldTypWerteStandardBeschreibung
colorSchemestringlight dark autoautoFarbmodus. auto folgt der Systemeinstellung des Besuchers.
accentColorstringHex, z. B. #6366f1#6366f1Akzentfarbe für Highlights, Rahmen und Verläufe

Typografie & Stil

FeldTypWerteStandardBeschreibung
fontFamilystringsystem monosystemsystem = Standard-Serifenloser, mono = Monospace
cardRadiusstringnone md xlmdAbrundung der Karten: none = eckig, md = abgerundet, xl = stark abgerundet
FeldTypWerteStandardBeschreibung
headerStylestringsimple centered herosimplesimple = linksbündig, centered = zentriert, hero = breites Gradient-Banner
customTitlestringmax. 120 Zeichen""Überschreibt den Seitennamen im Header. Leer lassen, um den Seitennamen zu verwenden.
customSubtitlestringmax. 200 Zeichen""Optionaler Untertitel unterhalb des Titels

Anzeigeoptionen

FeldTypStandardBeschreibung
showUptimeStatsbooleantrueVerfügbarkeitsprozent und Dienst-Übersicht anzeigen
showServiceUrlsbooleanfalseÜberwachte URL unterhalb des Dienstnamens anzeigen
showLastCheckedbooleanfalseZeitstempel der letzten Prüfung je Dienst anzeigen
showHistorybooleantrueHauptschalter für den Bereich mit Vorfällen und Wartungen
historyDaysinteger30Fenster der Verfügbarkeitsbalken, in Tagen (1-3650). Vorfälle und Wartungen haben eigene Fenster, siehe unten.

Vorfälle und Wartungen

Vorfälle und Wartungen sind zwei getrennte Abschnitte, jeder mit eigenem Schalter, eigener Anzahl und eigenem Zeitfenster.

FeldTypVorgabeBeschreibung
showIncidentsbooleantrueVorfallsabschnitt anzeigen
incidentLimitinteger5Wie viele Vorfälle aufgeführt werden (1-50)
incidentDaysinteger30Wie weit zurück behobene Vorfälle aufgeführt werden, in Tagen (1-3650). Ein offener Vorfall erscheint immer, unabhängig von seinem Alter.
showMaintenancebooleantrueWartungsabschnitt anzeigen
maintenanceLimitinteger5Wie viele Wartungen aufgeführt werden (1-50)
maintenanceDaysinteger30Wie weit zurück abgeschlossene Wartungen aufgeführt werden, in Tagen (1-3650). Angekündigte Wartungen erscheinen immer, egal wie weit sie entfernt sind.

showIncidents und showMaintenance sind dieselbe Einstellung wie showRecentIncidents und showRecentMaintenance an der Statusseite selbst: wer eines der beiden über POST /api/status-pages oder PATCH /api/status-pages/:id schreibt, aktualisiert damit auch die Design-Konfiguration, sodass beide übereinstimmen. | showPoweredBy | boolean | true | Eine Zeile „Powered by <Ihr Produktname>" im Footer anzeigen. Sie nennt den Produktnamen Ihrer Organisation und nie Uptimeify; ohne gesetzten Produktnamen wird nichts gerendert. |

Beispiel: Dunkles Timeline-Layout

curl -X PATCH "$BASE_URL/api/status-pages/db58058e-4b58-4d97-a314-3bb8e279a182/design" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "layout": "timeline",
    "colorScheme": "dark",
    "accentColor": "#f59e0b",
    "pageWidth": "lg"
  }'

Beispiel: Minimalistisch, kein Branding, volle Breite

curl -X PATCH "$BASE_URL/api/status-pages/db58058e-4b58-4d97-a314-3bb8e279a182/design" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "layout": "minimal",
    "colorScheme": "light",
    "pageWidth": "xl",
    "showPoweredBy": false,
    "showUptimeStats": false,
    "customTitle": "System-Status",
    "customSubtitle": "Live-Übersicht aller Dienste"
  }'

Antwort

{
  "designConfig": {
    "layout": "timeline",
    "colorScheme": "dark",
    "accentColor": "#f59e0b",
    "headerStyle": "simple",
    "fontFamily": "system",
    "cardRadius": "md",
    "pageWidth": "lg",
    "customTitle": "",
    "customSubtitle": "",
    "showPoweredBy": true,
    "showUptimeStats": true,
    "showServiceUrls": false,
    "showLastChecked": false,
    "showHistory": true,
    "historyDays": 30,
    "showIncidents": true,
    "incidentLimit": 5,
    "incidentDays": 30,
    "showMaintenance": true,
    "maintenanceLimit": 5,
    "maintenanceDays": 30
  }
}

Fehler

  • 400 Bad Request: ungültiger Feldwert (z. B. unbekannter Layout-Name oder falsches Hex-Farb-Format)
  • 401 Unauthorized: nicht angemeldet
  • 403 Forbidden: keine Admin-Rechte
  • 404 Not found: Status-Seite nicht gefunden

Auf dieser Seite