Cloud API Platform Docs logo Cloud API Platform Docs
Start building
Documentation

Cloud API platform · Documentation

Build with a cloud API that stays clear.

Find the authentication guidance, endpoint details, and practical starting points you need to ship a reliable integration.

Start building REST API · predictable by design
  • Fast integration
  • Clear auth
  • Structured endpoints

Platform overview

A predictable interface for cloud data

Use the REST API to connect your services, retrieve dependable data, and build integrations with clear, versioned endpoints.

  • Connect your services

    Integrate cloud resources through a consistent REST interface.

  • Authenticate requests

    Use API credentials to make authorized calls from your application.

  • Work with versioned endpoints

    Explore request parameters, response schemas, and status codes.

  • Handle common cases

    Find guidance for frequent integration questions and errors.

Authentication / 01

Authenticate your requests

Create an API key, keep it private, and send it as a bearer token with every request.

  1. Create an API key

    Generate a key in your project settings and use a separate key for each environment.

  2. Store it securely

    Save the key in a server-side environment variable. Do not expose it in browser code or commit it to source control.

  3. Send it with each request

    Set the Authorization header to Bearer <API_KEY>.

Request example curl 
curl https://api.example.com/v1/projects \
  -H "Authorization: Bearer $API_KEY" \
  -H "Accept: application/json"

API reference endpoint groups

Endpoints

Explore the API by resource. Start with Projects to create a workspace and find its configuration.

Projects

Start here

/v1/projects

GET POST

Create projects and retrieve their configuration.

Deployments

/v1/deployments

GET POST

Launch deployments and check their current status.

API keys

/v1/api-keys

GET POST DELETE

Create, list, and revoke credentials for your account.

Usage

/v1/usage

GET

Retrieve request and resource usage for a time period.

Requests require a valid credential. Read the authentication guide before using these endpoints.

Common questions

FAQ

Practical details to help you move from the API reference to a dependable integration.

What are the API rate limits?

Rate limits are applied per API key. Check the rate-limit response headers to see your current allowance and reset time; if you receive 429, wait until the reset window before retrying.

How do sandbox and production environments differ?

Use the sandbox to test requests with isolated credentials and test data. When your integration is ready, switch to your production API key and production base URL; sandbox data is not carried over.

What is the recommended way to handle API errors?

Check the HTTP status and error response body, then handle errors by type. Retry transient server errors with bounded exponential backoff; do not repeatedly retry validation or authentication errors without correcting the request.

How are API versions managed?

Requests use the API version configured for your account or specified in the request. Review version notes before upgrading, and test changes in the sandbox before adopting a new version in production.

What should I have ready before contacting support?

Include the affected environment, endpoint, approximate request time, and request or correlation ID. Share the response status and a redacted error body, but never send API keys, access tokens, or other secrets.