v1 Cloud API Platform Docs

Fast, reliable API documentation for developer onboarding and integration

Technical guides and reference endpoints to authenticate, send requests, and implement quickly with predictable responses.

Overview Authentication Endpoints FAQ

Overview

Cloud API Platform

A unified API surface for provisioning cloud resources, managing environments, and streaming operational events. Designed for fast onboarding, deterministic responses, and predictable pagination.

Key Capabilities

  • Resource lifecycle management with idempotent operations
  • Unified event stream for audit and observability
  • Consistent pagination, filtering, and sorting patterns
  • Scoped access controls and token rotation

Getting Started Flow

  1. 1 Create an API key in the developer console and store it securely.
  2. 2 Exchange the key for a scoped access token via the Authentication endpoint.
  3. 3 Call the /projects endpoint to enumerate resources and validate connectivity.
  4. 4 Subscribe to events to stream state changes in near real time.

Response Model Snapshot

Every endpoint follows the same envelope for stability and debuggability.

{
  "request_id": "req_8f4c2d...",
  "status": "success",
  "data": { /* resource payload */ },
  "errors": []
}

Authentication

API key and bearer token access

Every request must include an API key or bearer token in the Authorization header. Tokens are scoped to a workspace and inherit the permissions of the issuing service account.

Header format

Authorization: Bearer <YOUR_API_TOKEN>

# or using an API key
Authorization: ApiKey <YOUR_API_KEY>

Use Bearer for OAuth-issued tokens and ApiKey for long-lived keys. The platform rejects requests with missing or malformed headers.

Example request

curl -X GET "https://api.cloudplatform.example/v1/projects" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json"

Secure storage

Store keys in a secrets manager or encrypted environment variable. Avoid hard-coding credentials in source control or CI logs.

Least privilege

Create separate tokens per service and scope them to the minimal permissions required for the integration.

Best practices

  • Rotate tokens regularly and revoke unused keys immediately.
  • Send credentials only over TLS (HTTPS).
  • Never pass tokens in query strings or request bodies.

Endpoints

API reference by resource group

Browse common resources with concise method signatures. Each group below is formatted for quick scanning and copy-paste into your API client.

Users

/v1/users
GET /v1/users

List users with pagination and filters.

POST /v1/users

Create a new user record.

GET /v1/users/{id}

Fetch a specific user by id.

Projects

/v1/projects
GET /v1/projects

List projects for the authenticated org.

POST /v1/projects

Provision a new project workspace.

PATCH /v1/projects/{id}

Update project name, region, or status.

Usage Metrics

/v1/metrics
GET /v1/metrics/usage

Fetch current usage totals by project.

GET /v1/metrics/requests

Retrieve request counts over a date range.

POST /v1/metrics/export

Generate an export for offline analysis.

FAQ

Answers to common integration questions

Concise guidance for developers integrating the Cloud API Platform. Expand each topic for implementation details and troubleshooting steps.

What are the default rate limits? ▾

Standard accounts receive 120 requests per minute per API key. Burst capacity allows short spikes up to 200 requests per minute for 30 seconds.

For higher limits, request an increase from the support portal with expected traffic volume and use case.

Why am I seeing authentication failures? ▾

Verify the Authorization header uses the correct scheme and that your API key is active.

Common causes include expired keys, incorrect environment (prod vs. sandbox), or a missing required scope in the token.

How does versioning work? ▾

Versioning is URI-based (e.g., /v1/). We maintain backward compatibility within a major version.

Breaking changes are released only in new major versions with a 90-day deprecation notice for the prior version.

Is there a sandbox for testing? ▾

Yes. Use https://sandbox.api.cloudplatform.dev with a sandbox key.

Sandbox data resets nightly and responses are deterministic for repeatable tests.

How do I contact support? ▾

Open a ticket via the support console. Include request IDs, timestamps, and the endpoint path to speed up triage.

Enterprise plans receive a dedicated Slack channel and 24/7 on-call escalation.

Tip: If you are blocked, check the Authentication and Endpoints sections for required headers and examples.