API v2.0 · Documentation

Integrate the Cloud API in minutes, not days.

Everything you need to authenticate, call endpoints, and ship production-ready integrations — structured, versioned, and written for engineers who want answers fast.

Read the docs View endpoints

Jump to a section

Overview Authentication Endpoints FAQ
authenticate.sh 
$ curl -X POST https://api.cloudplatform.dev/v1/auth \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Response
{
  "status": "success",
  "token": "eyJhbGciOi...",
  "expires_in": 3600
}
Documentation / 01

Overview

A birds-eye view of the Cloud API Platform before you dive into Authentication and Endpoints.

The Cloud API Platform gives you a single, consistent REST interface for provisioning infrastructure, managing data pipelines, and orchestrating workloads across regions. Every resource is exposed through predictable, versioned endpoints so integrations remain stable as the platform evolves.

It's built for backend engineers, DevOps teams, and technical leads who need to automate infrastructure and application workflows without depending on a dashboard. If you can send an HTTP request, you can integrate with this API.

Key capabilities

  • Unified REST interface — one consistent contract across compute, storage, and networking resources.
  • Token-based authentication — short-lived bearer tokens with scoped permissions per key.
  • Predictable versioning — breaking changes only ship under a new /v{n} path.
  • Structured JSON responses — consistent error shapes and pagination across every resource.
  • Regional deployment control — target specific regions for latency and data-residency requirements.
Set up authentication Browse endpoints

Quick start

Every request needs a base URL and a bearer token. Send this call to confirm your key is active before wiring up real endpoints.

request.sh 
GET https://api.cloudplatform.dev/v1/status
Authorization: Bearer YOUR_API_KEY
Accept: application/json

// 200 OK
{
  "status": "operational",
  "region": "us-east-1",
  "version": "v1"
}
Read the Authentication docs
Security

Authentication

Every request to the Cloud API Platform must be authenticated using a bearer token issued for your account. Attach it to the Authorization header of each HTTP request — no session cookies, no OAuth dance, just a single key.

Auth flow

  1. Generate an API key

    From your dashboard, create a new API key scoped to the environment you need — sandbox or production.

  2. Attach the bearer token

    Add it to the Authorization header of every request as Bearer <API_KEY>.

  3. Send your request

    The platform validates the token on every call — no separate login step or session handshake required.

  4. Handle 401 responses

    If a request returns unauthorized, rotate or regenerate the key immediately, then retry with the new token.

Reference

API Endpoints

Core resources for integrating with the platform. Every request below is relative to the base URL and requires a valid bearer token — see Authentication for how to obtain one.

Base URLhttps://api.platform.com
GET/v1/usersList users

Returns a paginated list of user objects. Supports limit and cursor query parameters.

Request
curl -X GET "https://api.platform.com/v1/users?limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY"
Response200 OK
{
  "data": [
    { "id": "usr_8f2a1c", "email": "[email protected]", "name": "Ada Lovelace" }
  ],
  "meta": { "next_cursor": "usr_9b3d21" }
}
POST/v1/usersCreate a user

Creates a new user account and returns the created resource.

Request
curl -X POST https://api.platform.com/v1/users \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","name":"Ada Lovelace"}'
Response201 Created
{
  "id": "usr_8f2a1c",
  "email": "[email protected]",
  "name": "Ada Lovelace",
  "created_at": "2026-07-08T09:12:00Z"
}
GET/v1/users/{id}Retrieve a user

Fetches a single user by its unique identifier.

Request
curl -X GET https://api.platform.com/v1/users/usr_8f2a1c \
  -H "Authorization: Bearer YOUR_API_KEY"
Response200 OK
{
  "id": "usr_8f2a1c",
  "email": "[email protected]",
  "name": "Ada Lovelace",
  "created_at": "2026-06-02T14:31:09Z"
}
PATCH/v1/users/{id}Update a user

Updates one or more fields on an existing user. Omitted fields are left unchanged.

Request
curl -X PATCH https://api.platform.com/v1/users/usr_8f2a1c \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Ada K. Lovelace"}'
Response200 OK
{
  "id": "usr_8f2a1c",
  "email": "[email protected]",
  "name": "Ada K. Lovelace",
  "updated_at": "2026-07-08T09:20:44Z"
}
DELETE/v1/users/{id}Delete a user

Permanently deletes a user account. This action cannot be undone.

Request
curl -X DELETE https://api.platform.com/v1/users/usr_8f2a1c \
  -H "Authorization: Bearer YOUR_API_KEY"
Response204 No Content
// empty body
FAQ

Frequently asked questions

Quick answers about limits, versioning, errors, and support. For implementation details see the Authentication and Endpoints sections.

What are the API rate limits?

Standard plans are limited to 1,000 requests/min per API key. Exceeding the limit returns an HTTP 429 with a Retry-After header. Enterprise plans can request higher ceilings.

How does API versioning work?

Versions are path-based, e.g. /v1/, /v2/. Breaking changes always ship under a new major version, and a deprecated version remains supported for 12 months after its successor is released.

How are errors returned?

Every error response uses a consistent JSON envelope: { code, message, request_id }. HTTP status codes follow REST conventions — 4xx for client-side issues, 5xx for server-side failures.

Is a sandbox environment available?

Yes. sandbox.api.example.com mirrors production behavior without touching billing or live data. Authenticate with test keys prefixed sk_test_.

What support should I expect?

All tiers get access to the community forum. Paid plans include email support with a 24-hour response SLA, and Enterprise customers receive a dedicated Slack channel with priority escalation.

Can't find your answer? Reach out through the contact details in the footer.