Zum Inhalt springen
CitexNode
Alle Anleitungen

API und Statusseite einbinden

Die REST-API der Plattform, persönliche API-Tokens, ihre Dokumentation, und wie du den Status auf deiner eigenen Seite zeigst.

3 Min. Lesezeit

Die API

Alles, was das Dashboard kann, kann es über die REST-API der Plattform unter https://api.citexnode.com/api/v1; das Dashboard ist selbst nur ein Client. Die Dokumentation mit jedem Endpunkt, jedem Feld und jedem Fehlercode steht unter apidocs.citexnode.com, erzeugt aus derselben Version, die gerade antwortet.

Anmeldung läuft über die Login-Endpunkte; die Antwort ist ein Zugriffs- und ein Refresh-Token, das Zugriffs-Token geht als Authorization: Bearer mit. Fehler kommen immer als JSON in der Form {"error": {"code", "message", "details"}}, mit einem Code wie validation_failed oder insufficient_credits und Details, die du auswerten kannst.

Live-Daten und Konsole laufen über WebSockets mit einem kurzlebigen Ticket, das du vorher über die API holst.

Persönliche API-Tokens

Für Skripte, CI und Monitoring nimmst du statt deines Logins ein persönliches Token. Du legst es unter Konto → API-Tokens mit Neues Token an: Name, Rechte und wie lange es Gültig ist. Das Token beginnt mit cxp_, wird genau einmal angezeigt und geht als Authorization: Bearer cxp_… mit. Höchstens 10 Tokens sind gleichzeitig aktiv.

RechteDarf
Nur lesenGET auf dein Konto (/me), Instanzen, Deploy-Projekte, Domains und Statusseiten
Lesen & Schreibenzusätzlich Instanzen steuern (Power, Dateien, Backups, Zeitpläne), Deploy-Projekte neu bauen, starten und stoppen, Cronjobs auslösen, bei Statusseiten Vorfälle, Wartungen und Komponenten pflegen

Nie über ein Token: bestellen, verlängern, löschen, Mitglieder, Konto und Geld, SFTP- und Datenbank-Zugangsdaten, Deploy-Variablen und Auth-Codes von Domains. Das beantwortet die API mit 403 token_not_allowed. Widerrufen macht ein Token sofort ungültig.

Statusseite einbinden

Die Statusseite bietet zwei Bausteine für deine eigene Seite:

  • Badge: https://status.citexnode.com/de/badge.svg?theme=dark (oder light), ein SVG ohne Skript, das den Gesamtstatus zeigt.
  • Widget: https://status.citexnode.com/widget.js mit data-locale="de", das bei einer offenen Meldung eine kleine Karte unten links einblendet und sonst schweigt.
html
<script src="https://status.citexnode.com/widget.js" data-locale="de" data-theme="class" defer></script>

Feeds

Vorfälle und Wartungen gibt es als Atom-Feed je Sprache: https://status.citexnode.com/de/feed.xml und https://status.citexnode.com/en/feed.xml.

Eigene Statusseiten

Hast du bei uns eine eigene Statusseite unter statuscx.eu, pflegst du deren Vorfälle, Wartungen und Komponenten ebenfalls über die API, auch mit einem persönlichen API-Token. Siehe Statusseiten per API.