Skip to content

Responses and errors

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.

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.

StatusMeaningRecommended action
400 / 422Invalid inputFix the request; do not retry unchanged
401Authentication failedReplace or rotate the token
404Resource not foundVerify the account-scoped identifier
429Rate limit exceededBack off and retry with jitter
5xxService or downstream failureRetry 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.