Cloud API documentation

Reliable integration. Fast onboarding. Clear references.

A documentation-first API platform built for engineers who want predictable cloud integration, quick setup, and structured reference material. Navigate by topic or jump into the quick start to make your first request.

Quick start

Install the SDK and verify connectivity in under five minutes.

1. Install

curl -sSL https://cli.cloudapi.dev/install | sh

First request

Authenticate once, then access structured endpoints consistently.

2. Test

curl -H "Authorization: Bearer $TOKEN" \
  https://api.cloudapi.dev/v1/health
99.99% uptime SLA REST + JSON, predictable schemas Versioned endpoints with changelogs

Overview

Cloud API Platform

A minimal, reliable API surface for provisioning, monitoring, and automating cloud infrastructure. Designed for engineers who need predictable responses, strict versioning, and clear operational semantics.

Core capabilities

  • Provision and manage compute, storage, and networking with consistent CRUD semantics.
  • Unified observability endpoints for metrics, logs, and audit trails.
  • Idempotent operations with request IDs and safe retries.
  • Versioned API with explicit deprecation and compatibility windows.

Common use cases

  • Automate infrastructure provisioning in CI/CD pipelines.
  • Integrate service health checks into internal tooling.
  • Stream metrics into your observability stack.
  • Run compliance audits with audit-log exports.

Base URL

All requests are served over HTTPS and scoped to a versioned API base path.

https://api.cloudplatform.dev/v1

Response format summary

Responses are JSON with consistent envelopes for data, pagination, and errors.

{
  "data": { /* resource payload */ },
  "meta": { "request_id": "req_01J...", "timestamp": "2026-07-06T12:00:00Z" },
  "errors": []
}

Getting started checklist

  1. 1 Generate an API key in the console and store it securely.
  2. 2 Configure the Authorization header for all requests.
  3. 3 Review endpoint-specific parameters and rate limits.
  4. 4 Start with the health check endpoint to validate connectivity.

Authentication

API Key Authentication

Authenticate every request using a long-lived API key. Keys identify your workspace and are scoped by environment. Use the Authorization header with the Bearer scheme.

Example Authorization header

Required 
Authorization: Bearer {{YOUR_API_KEY}}

Send on every request. Do not place API keys in query parameters.

Step-by-step authentication flow

  1. 1. Create a key

    Generate a key in the dashboard for the desired environment.

  2. 2. Store securely

    Store in your secret manager or CI variables, never in source code.

  3. 3. Attach to requests

    Include the key in the Authorization header.

  4. 4. Rotate regularly

    Rotate keys periodically and revoke unused credentials.

Security best practices

Least privilege

Issue separate keys per service and restrict by environment.

Protect in transit

Always send requests over TLS and validate certificates.

Monitor usage

Track request logs and alert on unusual spikes.

Rotate & revoke

Rotate keys quarterly and revoke immediately when exposed.

Sandbox vs production

Sandbox keys are isolated from production data and have lower rate limits. Use them for integration testing. Production keys access live resources and should be stored in secure secrets infrastructure.

Compact notes

Use a different key per environment to avoid cross-environment access.

Never expose keys in client-side applications or public repositories.

API Reference

Endpoints

Canonical endpoints for resource management. Examples include method, path, and sample request/response to keep integrations consistent.

Base URL https://api.cloudgrid.dev/v1 Auth Authorization: Bearer <token>
GET /resources List resources with paging.

Sample Request

curl -X GET \
  https://api.cloudgrid.dev/v1/resources?limit=20&cursor=eyJpZCI6IjEyMyJ9 \
  -H "Authorization: Bearer <token>"

Sample Response

{
  "data": [
    {"id": "res_9f2", "name": "alpha", "status": "active"},
    {"id": "res_9f3", "name": "beta", "status": "active"}
  ],
  "next_cursor": "eyJpZCI6IjEyNCJ9"
}
GET /resources/{id} Fetch a single resource by identifier.

Sample Request

curl -X GET \
  https://api.cloudgrid.dev/v1/resources/res_9f2 \
  -H "Authorization: Bearer <token>"

Sample Response

{
  "id": "res_9f2",
  "name": "alpha",
  "status": "active",
  "created_at": "2026-06-01T12:44:31Z"
}
POST /resources Create a new resource.

Sample Request

curl -X POST \
  https://api.cloudgrid.dev/v1/resources \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"name":"alpha","region":"us-east-1"}'

Sample Response

{
  "id": "res_a12",
  "name": "alpha",
  "region": "us-east-1",
  "status": "provisioning"
}
PATCH /resources/{id} Update fields on a resource.

Sample Request

curl -X PATCH \
  https://api.cloudgrid.dev/v1/resources/res_9f2 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"name":"alpha-renamed"}'

Sample Response

{
  "id": "res_9f2",
  "name": "alpha-renamed",
  "status": "active",
  "updated_at": "2026-07-06T10:12:09Z"
}
DELETE /resources/{id} Remove a resource permanently.

Sample Request

curl -X DELETE \
  https://api.cloudgrid.dev/v1/resources/res_9f2 \
  -H "Authorization: Bearer <token>"

Sample Response

{
  "id": "res_9f2",
  "deleted": true,
  "deleted_at": "2026-07-06T10:18:42Z"
}

FAQ

Answers for common integration questions

Quick, developer-focused guidance on limits, authentication, versioning, and testing. Each answer is designed for fast scanning while you build.

What are the default rate limits?
The platform enforces a global 600 requests/min per API key and 20 concurrent requests. Rate limit headers are returned on every response for proactive throttling.
Why do authentication requests fail?
Check that the Authorization: Bearer <token> header is present, the token is unexpired, and the request is sent to the correct region. Invalid scopes return 403 with a descriptive error code.
How does API versioning work?
Versioning is URL-based: /v1/, /v2/. New versions are additive when possible, and deprecated endpoints remain available for at least 12 months with response headers indicating sunset dates.
What pagination strategy is used?
Collections use cursor-based pagination with page[size] and page[after]. The response includes next_cursor to avoid offset drift under heavy writes.
Do you support webhooks?
Yes. Webhooks are available for resource create/update/delete events. Configure signing secrets and retries in the developer console, then verify signatures using X-Signature and the request timestamp.
Is there a sandbox for testing?
The sandbox environment mirrors production with isolated data. Use api.sandbox.example.com and a sandbox key to run tests without impacting live resources.