v2 API · 99.99% uptime

Build on a reliable cloud API.

Documentation built for developers. Authenticate in minutes, understand the endpoint structure at a glance, and ship integrations with predictable, well-documented responses.

Fast integration, versioned endpoints, and reference docs kept in sync with the platform — no guesswork.

Get API Key Read the Docs

request.sh

# Authenticate and fetch a resource
curl -X GET \
  https://api.cloudplatform.dev/v2/resources \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json"

# Response 200 OK
{
  "id": "res_9f2c1a",
  "status": "active",
  "created_at": "2026-07-07T09:12:00Z"
}

Section 01 · Docs

Overview

The Cloud API Platform gives your team a single, predictable interface for provisioning, querying, and orchestrating infrastructure resources programmatically. It is built for engineers who need reliable, well-documented endpoints — not guesswork.

What the platform does

A REST + JSON API layer that sits in front of your cloud resources. Every action — creating a service, rotating a credential, reading usage metrics — is exposed as a versioned, authenticated HTTP endpoint with predictable request and response shapes.

Main capabilities

Resource provisioning & lifecycle management
Token-based authentication & scoped access
Real-time usage & billing metrics
Webhooks for async event delivery

Common use cases

Automating environment provisioning inside CI/CD pipelines
Building internal dashboards backed by live resource data
Syncing infrastructure state with third-party tooling
Programmatic key rotation and access audits

Sample workflow

A minimal end-to-end flow: authenticate, create a resource, confirm it's live.

workflow.sh

# 1. Authenticate
curl -X POST https://api.cloudplatform.dev/v1/oauth/token \
  -d "grant_type=client_credentials" \
  -d "client_id=$CLIENT_ID" -d "client_secret=$CLIENT_SECRET"

# 2. Create a resource
curl -X POST https://api.cloudplatform.dev/v1/resources \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{"name":"prod-service","region":"us-east-1"}'

# 3. Confirm status
curl https://api.cloudplatform.dev/v1/resources/prod-service \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Why developers choose it

Consistent JSON schemas, predictable error codes, versioned endpoints, and thorough reference docs mean less time reverse-engineering behavior and more time shipping. Read Authentication next to get your first token, or jump to Endpoints for the full reference.

02 / Security

Authentication

Every request to the Cloud API Platform must be authenticated using a bearer token. Tokens are issued per API key and scoped to your workspace, so requests without a valid Authorization header will be rejected with a 401 Unauthorized response.

API Keys

Generate an API key from your dashboard. Use it as a bearer token in the Authorization header on every request.

Token Lifecycle

Bearer tokens can be rotated or revoked at any time without affecting other active keys tied to your account.

Authorization Header

header

Authorization: Bearer sk_live_4f8a2c9d7e1b6a3f0c5d8e2a1b4c7d9e

Example Request

curl

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

Security Best Practices

Never expose API keys in client-side code, public repositories, or logs.
Store tokens in environment variables or a secrets manager, not hardcoded strings.
Rotate keys periodically and immediately revoke any key you suspect is compromised.
Scope keys to the minimum set of permissions required for your integration.
Always transmit requests over HTTPS to prevent token interception.

Explore Endpoints Back to Overview

API Reference

Endpoints

A representative sample of core resource operations. Every endpoint is versioned, JSON-only, and requires a valid bearer token in the Authorization header.

GET /v1/resources List resources

Returns a paginated collection of resources scoped to your workspace.

Query Parameters

Name	Type	Description
limit	integer	Max items to return (default 20)
cursor	string	Pagination cursor from a previous response

Request

curl -X GET "https://api.cloudplatform.dev/v1/resources?limit=20" \
  -H "Authorization: Bearer sk_live_..."

Response 200

{
  "data": [
    { "id": "res_1a2b", "name": "invoice-service", "status": "active" }
  ],
  "next_cursor": "eyJvZmZzZXQi..."
}

GET /v1/resources/{id} Retrieve a resource

Fetches a single resource by its unique identifier.

Path Parameters

Name	Type	Description
id	string	Unique resource identifier, e.g. res_1a2b

Request

curl -X GET "https://api.cloudplatform.dev/v1/resources/res_1a2b" \
  -H "Authorization: Bearer sk_live_..."

Response 200

{
  "id": "res_1a2b",
  "name": "invoice-service",
  "status": "active",
  "created_at": "2026-05-14T10:22:00Z"
}

POST /v1/resources Create a resource

Creates a new resource in your workspace and returns the created object.

Body Parameters

Name	Type	Description
name	string	Human-readable name, required
metadata	object	Optional key-value pairs

Request

curl -X POST "https://api.cloudplatform.dev/v1/resources" \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "invoice-service" }'

Response 201

{
  "id": "res_9f3c",
  "name": "invoice-service",
  "status": "active",
  "created_at": "2026-07-07T09:15:00Z"
}

Need to authenticate first? Review the token flow before calling these endpoints.

View Authentication →

FAQ

Frequently asked questions

Practical answers to common questions developers ask while integrating with the API.

What are the API rate limits?

Standard plans are limited to 120 requests per minute per API key, with burst allowance of 20 requests. Rate limit status is returned via X-RateLimit-Remaining and X-RateLimit-Reset response headers. Exceeding the limit returns a 429 status.

How does pagination work?

List endpoints use cursor-based pagination. Pass a limit query parameter (default 20, max 100) and follow the next_cursor value returned in the response body to fetch subsequent pages. There is no total count guarantee for large datasets.

What environments are available?

We provide separate sandbox and production environments, each with isolated data and independent API keys. Sandbox base URL is api.sandbox.example.com; use it to test integrations before switching to live credentials.

How is API versioning handled?

Versions are specified in the URL path, e.g. /v1/. Breaking changes are only introduced in a new major version, which runs in parallel with the previous one for a minimum 12-month deprecation window. Non-breaking additions ship without a version bump.

How are errors structured?

All errors return a consistent JSON shape: { "error": { "code", "message", "request_id" } } alongside a matching HTTP status code (4xx for client errors, 5xx for server errors). Include the request_id when contacting support.

Do you support webhooks?

Yes. Webhooks can be configured per event type from the dashboard and are signed with an HMAC-SHA256 signature in the X-Signature header. Failed deliveries are retried with exponential backoff for up to 24 hours.

What support can I expect?

All plans include email support with a 1 business-day response target. Paid tiers get priority routing and access to a shared Slack channel. Status and incident updates are posted on our status page in real time.

Still have questions?

Back to Overview