API and embedding the status page

The API

Everything the dashboard can do is available through the platform's REST API at https://api.citexnode.com/api/v1; the dashboard itself is just a client. The documentation with every endpoint, every field and every error code is at apidocs.citexnode.com, generated from the same version that is currently answering.

You sign in through the login endpoints; the response is an access token and a refresh token, and the access token goes along as Authorization: Bearer. Errors always come as JSON in the form {"error": {"code", "message", "details"}}, with a code such as validation_failed or insufficient_credits and details you can evaluate.

Live data and the console use WebSockets with a short-lived ticket that you fetch through the API first.

Personal API tokens

For scripts, CI and monitoring, use a personal token instead of your login. Create it under Account → API tokens with New token: Name, Permissions and how long it is Valid for. The token starts with cxp_, is shown exactly once and goes along as Authorization: Bearer cxp_…. At most 10 tokens can be active at the same time.

Never through a token: ordering, renewing, deleting, members, account and money, SFTP and database credentials, Deploy variables and domain auth codes. The API answers those with 403 token_not_allowed. Revoke makes a token invalid immediately.

Embedding the status page

The status page offers two building blocks for your own site:

• Badge: https://status.citexnode.com/en/badge.svg?theme=dark (or light), an SVG without a script that shows the overall status.
• Widget: https://status.citexnode.com/widget.js with data-locale="en", which shows a small card in the bottom left while an incident is open and stays silent otherwise.

<script src="https://status.citexnode.com/widget.js" data-locale="en" data-theme="class" defer></script>

Feeds

Incidents and maintenance are available as an Atom feed per language: https://status.citexnode.com/de/feed.xml and https://status.citexnode.com/en/feed.xml.

Your own status pages

If you have your own status page with us under statuscx.eu, you manage its incidents, maintenance and components through the API as well, including with a personal API token. See Status pages via the API.