Minden végpont application/json választ ad. A hibák az RFC 7807 (Problem+JSON) szabványt követik. Minden válasz X-Request-Id fejlécet tartalmaz a szerveroldali audit-naplóval való összevetéshez.
| Method | Path | Jogosultság | Cél |
|---|---|---|---|
| GET | /v1/health | public | Hitelesítés nélküli állapot-ellenőrzés. |
| GET | /v1/me | any | Saját fiókinformáció és kulcs metaadatok. |
| GET | /v1/products | read:products | Minden nyilvánosan listázott termék listája árakkal. |
| GET | /v1/products/{id} | read:products | Termékadatok, beleértve a konfigurációs opciókat. |
| POST | /v1/orders | write:orders | Megrendelés leadása. Idempotency-Key kötelező. |
| GET | /v1/orders/{id} | read:orders | Saját megrendelés állapota. |
| GET | /v1/services | read:services | Saját szolgáltatások listája (lapozott). |
| GET | /v1/services/{id} | read:services | Saját szolgáltatás részletei. |
| GET | /v1/services/{id}/credentials | read:credentials | Szolgáltatási hozzáférési adatok (külön jogosultság, audit-naplózott). |
| POST | /v1/services/{id}/actions | write:services | Szolgáltatási művelet: start, stop, reboot, reinstall, suspend, unsuspend, terminate. |
| GET | /v1/billing/balance | read:billing | Egyenleg. |
| GET | /v1/billing/invoices | read:billing | Saját számlák listája (lapozott). |
| GET | /v1/billing/invoices/{id}/pdf | read:billing | Számla PDF. |
| GET | /v1/webhooks | read:webhooks | Aktuális webhook URL. |
| PUT | /v1/webhooks | write:webhooks | Webhook URL beállítása vagy törlése. |
Idempotencia
A POST /v1/orders és POST /v1/services/{id}/actions kérések Idempotency-Key fejlécet igényelnek (1-80 karakter [A-Za-z0-9_.-] készletből). A szerver 24 óráig gyorsítótárazza a választ és a törzs hash-ét; egy második kérés azonos kulccsal és azonos törzzsel ugyanazt a választ adja, egy második kérés azonos kulccsal de eltérő törzzsel 409 idempotency_conflict hibával elutasításra kerül.
Sebességkorlátok
Alapértelmezett: 60 kérés/perc (20-as burst tűréssel) és 5000/nap kulcsonként, plusz 600 kérés/perc IP-címenként, a kulcstól függetlenül. Túllépés esetén HTTP 429 válasz érkezik Retry-After fejléccel. Az X-RateLimit-Remaining és X-RateLimit-Reset válaszfejlécek mutatják az aktuális állapotot.
