v2.4 documentation

Fast, reliable API docs for every integration path.

Find authentication flows, endpoint definitions, and error behavior in a concise format built for developers. Navigate by section or jump straight into the reference with predictable, stable URLs.

Read the API Reference Start with Overview

Status: 99.99% uptime • Latency: <120ms average • Regions: us-east, eu-west, ap-south

The Cloud API Platform exposes a consistent, versioned REST interface for provisioning infrastructure, managing environments, and retrieving operational telemetry. Every resource follows a predictable URI pattern, and all responses are JSON with typed error objects.

Requests are authenticated using signed bearer tokens and scoped to a workspace. Resource IDs are globally unique and stable across environments, enabling safe automation and deterministic tooling.

Base URL

https://api.cloudplatform.example.com/v1

All endpoints are versioned. New versions are additive and announced in advance.

Response format

{ "data": { ... }, "meta": { "requestId": "..." } }

Errors return a consistent structure with code, message, and details.

Rate limits

Default limit is 600 requests / 10 minutes per workspace. Burst capacity is available for approved partners.

429 Too Many Requests

Core concepts

Workspace is the tenancy boundary; all resources are scoped to a workspace ID.
Environment represents an isolated deployment context (dev, staging, prod).
Resource identifiers are immutable and can be safely cached in client tooling.
Idempotency keys prevent duplicate creates across network retries.

Authentication

The Cloud API Platform uses API key authentication. Every request must include a valid key in the Authorization header.

API Key Format

Send the key using the Bearer scheme. Keys are provisioned in the dashboard and scoped to your workspace.

Authorization: Bearer <your_api_key>

cURL Example

Replace the placeholder with your API key. Requests without valid keys return 401 Unauthorized.

curl https://api.cloudplatform.dev/v1/projects \
  -H "Authorization: Bearer $CLOUD_API_KEY" \
  -H "Accept: application/json"

Environment Variable

Store the key in an environment variable and load it at runtime.

export CLOUD_API_KEY="sk_live_************************"

Security Best Practices

Never commit API keys to source control or client-side code.
Rotate keys on a regular schedule and after team changes.
Limit key scopes to the minimum permissions required.

API Reference

Endpoints

Concise examples for core resources. Each endpoint includes a short description and a compact request/response pair.

GET /v1/projects

List all projects visible to the current API token.

Request

curl -H "Authorization: Bearer $TOKEN" \
  https://api.cloud.example/v1/projects

Response

{
  "data": [
    {"id": "prj_9af2", "name": "alpha"},
    {"id": "prj_42b1", "name": "beta"}
  ]
}

POST /v1/projects

Create a new project with a human-readable name.

Request

curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"gamma"}' \
  https://api.cloud.example/v1/projects

Response

{
  "id": "prj_77f2",
  "name": "gamma",
  "created_at": "2026-03-18T10:22:09Z"
}

GET /v1/usage

Retrieve month-to-date usage by project.

Request

curl -H "Authorization: Bearer $TOKEN" \
  https://api.cloud.example/v1/usage

Response

{
  "month": "2026-03",
  "requests": 148902,
  "projects": 3
}

DELETE /v1/projects/{id}

Remove a project and revoke all associated keys.

Request

curl -X DELETE -H "Authorization: Bearer $TOKEN" \
  https://api.cloud.example/v1/projects/prj_77f2

Response

{
  "deleted": true,
  "id": "prj_77f2"
}

FAQ

Frequently asked questions

Straightforward answers for common integration questions. Each response is optimized for fast scanning.

What are the default rate limits? ▾

Standard plans allow 120 requests per minute per API key. Burst traffic is smoothed with a 60-second rolling window. Contact support for higher limits.

Is there a sandbox environment? ▾

Yes. Use the sandbox base URL and test keys to simulate requests without billing. Data resets every 24 hours.

How is API versioning handled? ▾

Versioning is path-based (e.g., /v1/). New versions are released with 6 months of overlap and deprecation notices in response headers.

What is the error response format? ▾

Errors return JSON with status, code, message, and request_id fields. All 4xx/5xx responses include a machine-readable error code.

How do webhook retries work? ▾

Failed webhooks are retried with exponential backoff over 24 hours. Responses must return a 2xx within 10 seconds to stop retries.