Warning: JavaScript is not enabled or not loaded. Please enable JavaScript for the best experience.
Cloud API Platform logo

Developer Docs

Cloud API Platform

Navigate docs

API v1 • Stable

Build, authenticate, and ship integrations faster with a clean cloud API surface.

Production-ready REST endpoints, token-based auth, predictable versioning, and concise docs designed for teams that move quickly.

Quick Start Request

GET 
curl -X GET 'https://api.cloudplatform.dev/v1/projects' \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json'

Platform intro

The Cloud API Platform exposes versioned REST endpoints and webhook events for account data, usage telemetry, and workflow automation. Responses are JSON, errors are standardized, and all resources are addressable with predictable URL patterns for fast integration.

Core capabilities

  • OAuth 2.0 and API key authentication with scoped access control.
  • Consistent pagination, filtering, and idempotent write operations for safe retries.
  • Real-time webhooks for asynchronous state changes and operational events.
  • Typed error model with machine-readable codes for automated fallback handling.

What you can build

Example: an internal usage monitor that syncs account metrics every 5 minutes and triggers alerts when quota utilization exceeds a threshold. 

GET /v1/accounts/{id}/usage?window=5m
POST /v1/alerts
{
  "account_id": "acc_123",
  "rule": "quota_percent > 85",
  "channel": "slack"
}

Documentation

Authentication

Authenticate every request with a project-scoped API key. Send the key in the Authorization header using the Bearer scheme. Requests without valid credentials return 401 Unauthorized.

API key authentication model

Each API key is bound to a workspace and inherits that workspace permissions. Use separate keys for local development, staging, and production.

  • Generate keys in the platform dashboard under Settings → API Keys.
  • Store keys in environment variables; never commit them to source control.
  • Rotate keys regularly and revoke compromised keys immediately.

Authorization header format

Include this header in every request:

Authorization: Bearer <YOUR_API_KEY>

Quick start

  1. 1Create an API key in your dashboard and copy it once.
  2. 2Set it locally as CLOUD_API_KEY.
  3. 3Send your first request to a test endpoint and verify a 200 OK response.

Code example

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

Need request shapes and response schemas? Continue to Endpoints.

API Reference

Endpoints

Use these core endpoints to list projects, read project details, and create API keys. All requests use JSON over HTTPS and return predictable status/error objects.

  1. GET /v1/projects

    Returns a paginated list of projects available to the authenticated workspace.

    Sample response summary

    200 OK · {"items":[{"id":"prj_91f","name":"Payments"}],"page":1,"has_more":true}

  2. GET /v1/projects/{project_id}

    Fetches a single project by ID, including environment metadata and current usage counters.

    Sample response summary

    200 OK · {"id":"prj_91f","name":"Payments","env":"prod","requests_24h":48320}

  3. POST /v1/api-keys

    Creates a scoped API key for service-to-service access with optional expiration and role constraints.

    Sample response summary

    201 Created · {"key_id":"key_2hK7","prefix":"pk_live_","scope":["read:projects"],"expires_at":"2026-12-31T23:59:59Z"}

Documentation

FAQ

Practical answers for common integration issues. Keep this page bookmarked while building.

What are the API rate limits?
Default limit is 120 requests / minute per API key. When exceeded, the API returns 429 Too Many Requests with Retry-After and reset headers.
How does API versioning work?
Versions are path-based (for example, /v1, /v2). Minor backward-compatible changes ship without version bumps. Breaking changes are introduced in a new major version with migration notes.
Is there a sandbox or test environment?
Yes. Use sandbox keys to call the isolated test environment with mock-safe data. Sandbox responses follow production schemas, but throughput limits are lower and data is reset periodically.
How should I handle API errors?
Parse both HTTP status and the structured error body. Retry transient failures (429, 500, 503) with exponential backoff. Do not retry validation/authentication failures (400, 401, 403).
Do you support idempotent writes?
Yes. Send an Idempotency-Key header for create/update operations. Replayed requests with the same key return the original outcome to prevent duplicate writes during retries.