Cloud API Docs logo Cloud API Docs
Start building

Documentation

Start building

Cloud API / Documentation

Build with the Cloud API.

A developer-first cloud API reference for taking your integration from first request to production.

Explore the overview, configure authentication, find your endpoints, and get answers to common implementation questions.

Start building
  • RESTful structure
  • Token authentication
  • Implementation-ready examples

01Platform fundamentals

Overview

One API for your cloud resources, events, and account workflows. A clear path from your first request to production.

A practical model for integration

Think in resources and operations: identify what you need to work with, authenticate your request, then choose the endpoint that performs the action.

  • Resources define the scope. Start with the objects your application needs to create, retrieve, or update.
  • Authentication establishes access. Follow the authentication guide before making requests to protected endpoints.
  • Responses drive the next step. Use endpoint guidance to understand results and handle failures in your integration.

Core API areas

04 capabilities
01Resource management
Create, inspect, and update cloud resources throughout their lifecycle.
02Event handling
Connect resource changes and platform events to application workflows.
03Account operations
Work with account-level settings and the context your integration operates within.
04Observability
Understand request outcomes and use available diagnostic details to troubleshoot failures.

02 / Access & security

Authentication

Authenticate every API request with a bearer token for the environment you’re using.

Token-based access, step by step

  1. Create a token

    Create an API token in your account’s token settings. Grant only the permissions your integration needs.

  2. Match the environment

    Keep sandbox and production tokens separate. Configure the token and API base URL together for each deployment.

  3. Send an authenticated request

    Include Authorization: Bearer <token> on every request. Use HTTPS; never put tokens in URLs.

Request conventions

Authorization
Required. Use the Bearer scheme followed by one space and your token.
Content-Type
Set to application/json when sending a JSON body.
Accept
Use application/json for JSON responses.

03 / API REFERENCE

Endpoints

Explore the core resource families and the request patterns used throughout the API.

Resource families

Representative operations

Projects

GET /v1/projects

List projects available to the authenticated account.

Use project identifiers to scope resource operations and organize environments.

Tokens

POST /v1/tokens

Create a scoped access token for an integration.

Grant only the permissions required and keep credentials in server-side secret storage.

Events

GET /v1/events

Retrieve a chronological record of resource activity.

Use events to investigate changes and support operational monitoring.

Usage

GET /v1/usage

Read consumption metrics for your account.

Track resource utilization to inform capacity planning and cost reviews.

Request pattern Shell / cURL 
curl --request GET \
  'https://api.example.com/v1/projects' \
  --header "Authorization: Bearer ${CLOUD_API_TOKEN}" \
  --header 'Accept: application/json'

Illustrative routes and host. Replace the host with your API base URL and set CLOUD_API_TOKEN in your environment.

Before sending a request, review Authentication for credential setup.

Implementation notes

Frequently asked questions

Practical answers for moving from your first request to a production integration.

What happens when my authentication expires?

An expired credential can no longer authorize requests. Obtain a valid credential using the documented authentication flow, then retry the request. Keep credentials on the server and avoid retrying authentication failures indefinitely. See Authentication for the supported flow and expiry rules.

How should I handle rate limits?

When a request returns 429, pause before retrying. Honor the Retry-After header when present; otherwise use bounded exponential backoff with jitter. Limit concurrent requests and only retry operations that are safe to repeat. Check the endpoint documentation for applicable limits.

What changes between sandbox and production?

Use the documented base URL and credentials for the environment you are targeting. Keep sandbox and production configuration separate, and do not assume test data or credentials carry over. Before switching, verify production access, permissions, and any environment-specific limits in the Overview.

How do I retrieve every page of results?

Follow the pagination mechanism documented for the endpoint: a cursor, next-page link, or page parameter. Keep filters and sorting consistent across requests, treat cursors as opaque values, and stop when the response indicates there are no more pages. The endpoint reference defines the exact parameters and response fields.

How should I parse an error response?

Use the HTTP status to classify the failure, then parse the documented error body for details. Branch on stable error codes when provided, not human-readable messages. Log a request identifier when available, without credentials or sensitive payloads. Handle missing fields and non-JSON responses defensively; see the endpoint reference for the exact error structure.

What should I complete before going live?

Confirm account access and required permissions, configure credentials securely, and complete a successful test request. Exercise pagination, authentication failures, and retry behavior before enabling production traffic. Add request logging and monitoring, and verify any production approval requirements in the onboarding guidance.

Ready to make your first request?

Start building