Cloud API

Developer Docs

Cloud API Documentation

Reference guides, authentication flows, and endpoint specs designed for fast integration. Stable versioned APIs, predictable pagination, and clear error semantics.

Read Overview Get API Key

99.99% uptime SLA OpenAPI 3.1 schema Rate limits per key

Example request

cURL

curl -X POST https://api.cloud.example/v1/deployments \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "region": "us-west-2",
    "runtime": "nodejs20",
    "scaling": { "min": 2, "max": 12 }
  }'

200 OK · deployment_id, status, created_at

Overview

Cloud API Platform

The Cloud API Platform provides unified access to storage, compute, and event services through a consistent REST interface. It is designed for predictable performance, strict versioning, and clear error semantics.

Key capabilities

Versioned endpoints with backward compatibility guarantees.
Consistent pagination, filtering, and idempotency controls.
Typed error responses with traceable request IDs.
Regional base URLs for latency-aware routing.

Response format

All endpoints return JSON with a stable envelope for data and metadata.

Envelope

data, meta, errors, request_id

Base URL

Select the nearest regional host for lower latency.

https://api.cloudplatform.example/v1

Quick start

Create an API key in the console and store it securely.
Send the key in the Authorization: Bearer header.
Use GET /status to verify connectivity.
Read endpoint schemas before enabling write operations.

Security

Authentication

Cloud API uses API key authentication. Include your key in every request to authenticate and authorize access to your workspace.

API key usage

Generate keys in the dashboard and store them securely. Keys identify your application and inherit workspace-level permissions.

Authorization header

Authorization: Bearer <YOUR_API_KEY>

Security notes

Never expose keys in client-side code or public repositories.
Rotate keys regularly and revoke unused keys immediately.
Use environment variables and secret managers for storage.

Sample request

Example using curl to list recent audit events.

curl -X GET "https://api.cloudplatform.dev/v1/audit/events" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json"

Endpoints

API reference endpoints

Each endpoint is designed for predictable, low-latency integration. All responses are JSON and include a requestId for traceability.

Create token

POST /auth/token

Latency: ~120ms

Exchange client credentials for a short-lived access token used to authorize requests.

Sample response

{
  "accessToken": "eyJhbGci...",
  "expiresIn": 3600,
  "tokenType": "Bearer",
  "requestId": "req_4f92c1"
}

Status codes: 200 success, 401 invalid credentials.

List resources

GET /resources

Cache: 60s

Retrieve paginated resources filtered by project and environment.

Sample response

{
  "items": [
    {"id": "res_712", "name": "payments-api", "status": "active"},
    {"id": "res_825", "name": "billing-sync", "status": "active"}
  ],
  "nextCursor": "c_18a9",
  "requestId": "req_a9b7ef"
}

Status codes: 200 success, 403 scope denied.

Create deployment

POST /deployments

Async job

Provision a new deployment target with region and runtime configuration.

Sample response

{
  "deploymentId": "dep_0991",
  "region": "us-east-1",
  "state": "provisioning",
  "requestId": "req_d31f9a"
}

Status codes: 201 created, 422 invalid payload.

FAQ

Questions developers ask most

Concise answers to help you integrate quickly and predictably.

What are the API rate limits? +

Default limit is 1,000 requests/min per project. Burst limits are enforced; you receive HTTP 429 with a retry-after header.

How does versioning work? +

Versioning is URI-based (e.g., /v1). We maintain backward compatibility within a major version and deprecate with 90-day notice.

Is a sandbox environment available? +

Yes. Use the sandbox base URL and test keys. Data is isolated, rate limits are lower, and responses are deterministic for repeatable tests.

How are errors returned? +

Errors use standard HTTP codes with a JSON body: { "code", "message", "request_id" } for tracing and support.

Which SDKs are supported? +

Official SDKs are available for JavaScript, Python, and Go. Community SDKs are listed in the repository with version badges.