Cloud API Docs logoCloud API Docs
Cloud API Docs
Start building

REST API · Documentation

Cloud API documentation, built for integration speed.

Authenticate, explore every endpoint, and ship your first request in minutes.

Concise guides and precise reference material — no marketing layer between you and the spec.

Start buildingGet an API key →
  • Clear authentication
  • Predictable endpoints
  • Fast integration
request-flow.v1
clientgatewaycomputestorageeventsauth · bearerHTTPS
GET/v1/resources200 OK · 42ms
Every request follows the same path: authenticate once, then call any service.

01 / Getting started

Overview

One REST API for compute, storage, and events — authenticate once, then call any resource with consistent JSON contracts.

  • versioned
  • predictable
  • scalable
Core capabilities3 modules

Resource-oriented REST

GET · POST · PATCH · DELETE

Every object is a URL with standard verbs, typed JSON bodies, and uniform error codes you can handle once.

Pinned API versions

Api-Version: 2026-09

Lock requests to a dated version header. Breaking changes ship behind new versions with a 12-month deprecation window.

Built to scale

cursor pagination · idempotency

Idempotency keys, cursor-based pagination, and clear rate-limit headers keep high-volume integrations safe to retry.

02 / Secure access

Authentication

Every request is authorized with a bearer token. Generate a token scoped to your project, send it in the Authorization header, and the API validates it before any endpoint logic runs.

Requests without a valid token return 401 Unauthorized. Tokens can be rotated or revoked at any time.

  1. Create an API token

    Open the console, choose a project, and generate a token with only the scopes your integration needs.

  2. Store it as an environment variable

    Load the token at runtime as API_TOKEN instead of hard-coding it in source.

  3. Send it with every request

    Add the Bearer header shown in the reference panel. All traffic must use HTTPS.

Request · Authorization header
HTTP
GET /v1/projects HTTP/1.1
Host: api.example.cloud
Authorization: Bearer $API_TOKEN
Accept: application/json
200 OK · token validated401 · missing or invalid token

03 / Reference

Endpoints

The API is grouped into four resource families, each following the same REST conventions, JSON payloads, and versioned paths.

Base URLhttps://api.cloud.dev/v1
  • GETPOST

    Projects

    /v1/projects

    Create, list, and configure the workspaces that scope every other resource.

  • POSTDELETE

    Deployments

    /v1/deployments

    Ship, roll back, and inspect service releases across regions.

  • GETPUT

    Storage

    /v1/storage/objects

    Upload, retrieve, and manage objects with signed URLs and metadata.

  • GETSTREAM

    Events & Webhooks

    /v1/events

    Subscribe to platform events and receive signed webhook deliveries.

All endpoints require a bearer token. See Authentication.

Start building

05 Reference

FAQ

Short answers to the questions teams ask right before shipping their first integration.

01What are the default rate limits?

Standard keys allow 600 req/min per project. Every response includes X-RateLimit-Remaining and X-RateLimit-Reset. Exceeding the limit returns 429; retry after the reset timestamp.

02How is the API versioned?

Major versions live in the path, e.g. /v2/. Additive changes ship without a version bump. Breaking changes get a new major version, and the previous one is supported for at least 12 months after deprecation notice.

03Is there a sandbox environment?

Yes. Use sandbox.api.example.com with a key prefixed sk_test_. Sandbox mirrors production endpoints, but data is isolated and reset every 30 days.

04How should I handle errors?

Errors use standard HTTP status codes and a JSON body with code, message, and request_id. Retry 429 and 5xx with exponential backoff; fix the request for other 4xx codes.

05What support response times can I expect?

Free plans get community and email support within 2 business days. Paid plans get a first response within 4 hours for production incidents. Include the request_id to speed up diagnosis.

Ready to make your first request?

Grab a sandbox key and call your first endpoint in minutes.

Start buildingView endpoints