Cloud API Docs logo Cloud API Docs
Documentation

Cloud API documentation

Build against the API with confidence.

Clear reference material for authentication, endpoints, and predictable cloud integrations.

  • REST-first design
  • Token auth
  • Predictable responses
Read the docs

Platform overview

Build reliable cloud workflows with one predictable API.

Cloud API provides a consistent interface for creating, reading, and coordinating cloud resources. Start with a token, make standard HTTPS requests, and use the reference below to move from first call to production integration.

With Cloud API, you can:

  • Create and manage cloud resources programmatically.
  • Authenticate services with scoped access tokens.
  • Query resource state with clear, versioned endpoints.
  • Handle common integration questions without leaving the docs.
Review authentication

Security / 01

Authenticate every request.

Use a project-scoped API token in the Authorization header to make authenticated calls.

Token workflow

  1. 1

    Create a project token

    In the Console, open your project’s API settings and create a token with the minimum scopes required for your integration.

  2. 2

    Store it outside your source code

    Save the value as CLOUD_API_TOKEN in your environment or secret manager before starting your service.

  3. 3

    Send the bearer header

    Include the token on every request to the API. Requests without a valid token return 401 Unauthorized.

Request header Required
Authorization: Bearer $CLOUD_API_TOKEN
Continue to Endpoints

Reference surface

Endpoints

A consistent set of resource groups for the core objects and activity in your workspace.

Resource group

Accounts

Create, retrieve, and manage account-level configuration.

GET /v1/accounts/{id} PATCH /v1/accounts/{id}

Resource group

Projects

Organize environments, credentials, and project settings.

GET /v1/projects POST /v1/projects

Resource group

Usage

Query metered activity and aggregate consumption over time.

GET /v1/usage GET /v1/usage/summary

Resource group

Events

Inspect delivery events and manage webhook subscriptions.

GET /v1/events POST /v1/webhooks

Responses use predictable resource envelopes, pagination fields, and standard error objects across endpoint groups.

Browse API FAQ

Help center

Frequently asked questions

Practical details for building, testing, and operating your integration.

What are the API rate limits?

Limits are enforced per API key and endpoint. Read the endpoint reference for current quota headers and retry guidance.

Which environments are available?

Use the sandbox for development and integration tests, then switch to production with a production API key. Environment credentials are not interchangeable.

How is API versioning handled?

Versions are specified in the request path. Existing major versions remain stable; breaking changes are released only in a new major version.

How should I handle API errors?

Parse the JSON error code, log the request ID, and retry only documented transient responses such as 429 and 5xx with exponential backoff.

What support should I expect?

Documentation and status information are self-service. Include your request ID, endpoint, timestamp, and sanitized response when contacting technical support.

Back to Overview