Skip to main content
public preview

This is a proposed contract. No concrete public host or key-issuer URL is published. Every command and response is illustrative.

Error contract preview

Review the proposed error and status semantics.

Proposed error response format

The proposed contract uses this illustrative JSON shape:

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

Proposed HTTP status semantics

These mappings describe the proposed contract.

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. The proposed client behavior is retry with backoff.

500

Internal Server Error

Unexpected server error. The proposed client behavior is retry or contact support.

Illustrative error codes

These identifiers illustrate the proposed error vocabulary.

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.