Cloud API Docs logo Cloud API Docs
Get API Keys

Documentation

Get API Keys

Cloud API / Developer docs

A clear, fast cloud API. Built for builders.

Go from platform overview to your first authenticated request—without the guesswork.

Get API Keys Explore Endpoints
  • Fast integration
  • Clear auth flow
  • Structured endpoints
request_flowAPI
01

Create an API key

API_KEY

02

Authenticate your request

Authorization: Bearer <key>

03

Work with the response

{ JSON }

key → request → response

Overview

Access cloud resources through a consistent API, from authentication to your first request.

01 / Resources

Resource access

Read and manage cloud resources through a single API interface.

02 / Credentials

Authentication readiness

Use API keys to authenticate requests from your application.

03 / Requests

Predictable endpoints

Find the methods, parameters, and responses for each operation.

04 / Integration

Faster integration

Move from the documentation to a working authenticated request.

Built for your workflow

  • Connect backend services to cloud resources.
  • Automate repeatable resource management tasks.
  • Evaluate request and response patterns before integrating.

02 / ACCESS

Authentication

Use an API key to authenticate your first request.

An API key identifies your application and grants access to the API. Include it with each request, and treat it like a password.

Set up in three steps

  1. Step 1: Get your API key

    Create a key for the environment you want to use.

    Get API Keys

  2. Step 2: Send it with each request

    Pass your key in the Authorization header using the Bearer scheme.

    Authorization: Bearer YOUR_API_KEY

  3. Step 3: Keep your key private

    Store it in a server-side environment variable or secret manager. Never commit it to source control or expose it in browser code.

Implementation notes

  • Use HTTPS. Send keys only over encrypted connections, never in URL query parameters.
  • Check authentication failures. For a 401 response, verify the key and header before retrying.
  • Rotate safely. Deploy a replacement key before revoking the old one.
Explore Endpoints

03 / REFERENCE

Endpoints

Explore four core API areas through illustrative endpoint patterns.

Projects

Organize resources into separate workspaces.

  • GET /v1/projects

    List the projects available to your key.

  • POST /v1/projects

    Create a workspace for a new integration.

Resources

Inspect and configure your cloud resources.

  • GET /v1/resources/{id}

    Read a resource’s current configuration.

  • PATCH /v1/resources/{id}

    Update selected resource settings.

Jobs

Start work and track asynchronous operations.

  • POST /v1/jobs

    Submit a task for background processing.

  • GET /v1/jobs/{id}

    Check a task’s status and available results.

Usage & limits

Understand consumption and request capacity.

  • GET /v1/usage

    Review API activity for your workspace.

  • GET /v1/limits

    Inspect applicable quotas and rate limits.

HELP / FAQ

FAQ

A few practical answers before your first request.

How do I get and use an API key?

Create a key in your account, then include it in requests as described in the authentication guide. Keep keys on your server, never in public repositories or client-side code.

How should I separate test and production environments?

Use separate credentials and configuration for each environment. Confirm the base URL and key before sending a request, and keep production credentials out of local test configurations.

What happens when I reach a rate limit?

Handle 429 Too Many Requests responses with backoff. Respect the Retry-After header when present; check your account’s limits rather than assuming a fixed request allowance.

How should I handle API versions?

Use the version specified in the endpoint reference. Before upgrading, review the migration guidance and test your integration against the target version; do not assume versions are interchangeable.

What should I include when contacting support?

Include the endpoint, timestamp, request ID if available, and a sanitized example of the error. Never send API keys or sensitive payloads. Check your account’s support terms for availability and response-time commitments.

Ready for your first authenticated request?

Get API Keys