Most successful operations return a JSON object directly. List operations typically use:
{ "data": [], "page": 1, "pageSize": 20, "total": 0}VPN configuration operations return an archive rather than JSON. Inspect Content-Type before parsing the body.
Error shape
Section titled “Error shape”Documented failures use an object with an error string:
{ "error": "Human-readable error message"}Your client should preserve the HTTP status, request context, and safe response metadata. Do not log the bearer token or proxy password.
Retry policy
Section titled “Retry policy”| Status | Meaning | Recommended action |
|---|---|---|
400 / 422 | Invalid input | Fix the request; do not retry unchanged |
401 | Authentication failed | Replace or rotate the token |
404 | Resource not found | Verify the account-scoped identifier |
429 | Rate limit exceeded | Back off and retry with jitter |
5xx | Service or downstream failure | Retry safe operations with a bounded backoff |
Only retry a mutating request when you know whether the original attempt took effect. For order, payment, delete, reset, and update operations, read the resulting resource before repeating a request.