Response format, errors, rate limits and scopes

The Reseller API uses one predictable envelope for every response, so you can parse success and failure the same way across all endpoints.

Success responses

Successful responses return a top-level data field. It is an object for a single resource and an array for collections.

{
  "data": {
    "id": "svc_8fj2k",
    "category": "vps",
    "status": "running"
  }
}

Error responses

Errors return a top-level errors array. Each entry has a machine-readable code, the HTTP status, and a human-readable detail.

{
  "errors": [
    {
      "code": "insufficient_credits",
      "status": "402",
      "detail": "Your credit balance is too low to provision this plan."
    }
  ]
}

Common status codes

Rate limits

The default limit is 240 requests per minute per key. When you exceed it you get a 429 response. Inspect the rate-limit headers to pace your requests instead of retrying blindly.

X-RateLimit-Limit: 240
X-RateLimit-Remaining: 0
Retry-After: 12

Scopes

Each key can be restricted to a set of scopes when you mint it, so a key only does what it needs. A call that requires a scope the key lacks returns 403.

• read — read account, catalog, regions and services (GET endpoints).
• provision — create new services (POST /services).
• manage — power, console, reinstall, resize, suspend/unsuspend, backups, reset-password.
• terminate — delete services (DELETE /services/{id}).
• webhooks — read and update webhook configuration.