Errors & Status Codes

Understand and troubleshoot API errors.

Error Response Format

All errors return a consistent JSON structure:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error description",
    "details": {
      // Additional context (optional)
    }
  }
}

HTTP Status Codes

200

OK

Request successful. Response body contains the requested data.

201

Created

Resource successfully created (e.g., new instance).

204

No Content

Request successful. No response body (e.g., instance deleted).

400

Bad Request

Invalid request parameters or malformed JSON.

401

Unauthorized

Missing or invalid API key.

403

Forbidden

API key lacks necessary permissions.

404

Not Found

Resource does not exist (e.g., invalid instance UUID).

429

Too Many Requests

Rate limit exceeded. See rate limits documentation.

500

Internal Server Error

Unexpected server error. Contact support if persists.

Common Error Codes

INVALID_REQUEST

The request parameters are invalid or incomplete.

UNAUTHORIZED

Invalid or missing API key.

RESOURCE_NOT_FOUND

The requested resource (e.g., instance) does not exist.

QUOTA_EXCEEDED

Your organization has reached the instance limit.

RATE_LIMIT_EXCEEDED

Too many requests. Wait before retrying.

INTERNAL_ERROR

An unexpected error occurred. Contact support.