Funktionen des Portals

    Kunden-API

    Authentifizieren, Services auflisten und Power-Aktionen aus Ihren eigenen Skripten und Ihrer CI auslösen.

    5 Min. Lesezeit

    Mit der Kunden-API können Sie alles skripten, was Sie auch im Portal tun können: Services auflisten, Power-Aktionen auslösen, Rechnungen abrufen und SSH-Schlüssel verwalten.

    Erste Schritte

    1. API-Token erstellen

    Gehen Sie im Portal zu Profile settings → API Keys. Geben Sie dem Token einen Namen, wählen Sie das Team, zu dem er gehört, und vergeben Sie nur die Berechtigungen, die Sie brauchen (Least Privilege).

    Der Token wird einmal angezeigt. Kopieren Sie ihn sofort. Wenn Sie ihn verlieren, widerrufen Sie ihn und erstellen Sie einen neuen.

    2. Erste Anfrage senden

    Jede Anfrage geht an https://api.vboxx.eu/v1 und benötigt Ihren Token im Authorization-Header:

    curl https://api.vboxx.eu/v1/services \
      -H "Authorization: Bearer YOUR_TOKEN_HERE" \
      -H "Accept: application/json"
    

    Alle Payloads sind JSON. Senden Sie immer beide Header mit:

    Content-Type: application/json
    Accept: application/json
    

    Beispiel: einen Server neu starten

    Erfordert einen Token mit der Berechtigung services:power-action.

    Per IP:

    curl -X POST https://api.vboxx.eu/v1/services/power \
      -H "Authorization: Bearer YOUR_TOKEN_HERE" \
      -H "Content-Type: application/json" \
      -d '{"action": "reboot", "ip": "203.0.113.10", "reason": "CI runner stuck"}'
    

    Per Service-ID:

    curl -X POST https://api.vboxx.eu/v1/services/power \
      -H "Authorization: Bearer YOUR_TOKEN_HERE" \
      -H "Content-Type: application/json" \
      -d '{"action": "reboot", "service_id": "srv_abc123", "reason": "kernel panic"}'
    

    action ist on, off oder reboot. Das Feld reason ist Pflicht und landet in Ihrem Audit-Log.

    Rate Limits und Audit

    • 1 Power-Aktion pro Minute und Steckplatz.
    • Jede Anfrage wird mit Token-Name, Quell-IP, User Agent, Aktion, Grund und Ergebnis protokolliert.
    • Das vollständige Protokoll finden Sie unter Portal → Audit log.

    Verfügbare Endpunkte (Überblick)

    • GET /services, GET /services/{id}
    • POST /services/power
    • GET /invoices, GET /invoices/{id}/pdf
    • GET /tickets, POST /tickets
    • GET /me

    Die vollständige Referenz, in der Sie Anfragen direkt ausprobieren können, finden Sie unter Portal → Developers → API reference.

    Kommen Sie nicht weiter?
    Unser Support-Team in den Niederlanden antwortet per E-Mail und Telefon.