Klant-API
Authenticeer, vraag services op en start power-acties vanuit je eigen scripts en CI.
Met de klant-API kun je alles wat je in het portaal doet ook via scripts doen: services opvragen, power-acties starten, facturen ophalen en SSH-sleutels beheren.
Aan de slag
1. Maak een API-token aan
Ga in het portaal naar Profile settings → API Keys. Geef je token een naam, kies het team waar hij bij hoort en geef alleen de rechten die je nodig hebt (least privilege).
De token wordt één keer getoond. Kopieer hem meteen. Ben je hem kwijt, trek hem dan in en maak een nieuwe aan.
2. Doe je eerste request
Elk request gaat naar https://api.vboxx.eu/v1 en heeft je token nodig in de Authorization-header:
curl https://api.vboxx.eu/v1/services \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Accept: application/json"
Alle payloads zijn JSON. Stuur altijd beide headers mee:
Content-Type: application/json
Accept: application/json
Voorbeeld: een server herstarten
Hiervoor heb je een token met het rechtservices:power-action nodig.
Op IP-adres:
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"}'
Op 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 is on, off of reboot. Het veld reason is verplicht en komt in je auditlog terecht.
Rate limits en audit
- 1 power-actie per minuut per aansluiting.
- Elk request wordt gelogd met tokennaam, bron-IP, user agent, actie, reden en resultaat.
- Bekijk het volledige log onder Portal → Audit log.
Beschikbare endpoints (overzicht)
GET /services,GET /services/{id}POST /services/powerGET /invoices,GET /invoices/{id}/pdfGET /tickets,POST /ticketsGET /me
De volledige referentie, waarin je requests direct kunt uitproberen, vind je onder Portal → Developers → API reference.