Cloud API Docs logoCloud API Docs
Cloud API Docs

Developer documentation · v2

Cloud API documentation that gets to the point

Understand the platform, get through the authentication flow, and learn the endpoint structure quickly — without digging.

Read the docsReview authentication
  • Structured guidance
  • Authentication clarity
  • Endpoint-ready reference

01 / docs

Overview

The platform exposes cloud API capabilities through a clear, developer-focused integration model: authenticate once, call predictable resources, and handle responses the same way everywhere.

In these docs

  • Platform concepts and request model
  • API key and token authentication
  • Endpoint conventions and responses
  • Answers to common integration questions

Content map

  1. 02AuthenticationSet up keys and sign requests.
  2. 03EndpointsResource structure and methods.
  3. 04FAQCommon implementation questions.
  • REST-style flow
  • Predictable structure
  • Implementation-ready guidance

02 / Access

Authentication

Every request to the API requires authenticated access. Requests carry an API key as a bearer token; unauthenticated or invalid requests return 401 Unauthorized.

  1. 01

    Get credentials

    Create an API key in the console under Settings → API keys.

  2. 02

    Store them securely

    Keep the key in an environment variable or secrets manager, never in source code.

  3. 03

    Send them with each request

    Include the header Authorization: Bearer <API_KEY>.

  4. 04

    Validate the response

    Call GET /v1/auth/verify and confirm a 200 status before going further.

Implementation checklist

  • API key created and scoped
  • Key loaded from environment
  • Bearer header on all requests
  • 401 handling and retry logic in place
Next: Endpoints

03 — Reference

Endpoints

The API is organized into predictable resource groups. Every group follows the same URL pattern, HTTP verbs, and response shape, so once you learn one, you know them all.

/v1/projects

Projects

Create, list, update, and archive the workspaces that scope your resources.

/v1/deployments

Deployments

Trigger releases, inspect status, and roll back running services.

/v1/storage

Storage

Upload, retrieve, and manage objects and buckets with access controls.

/v1/events

Events & Webhooks

Subscribe to activity streams and receive signed webhook deliveries.

Requests

Base URL
api.cloud.dev/v1
Auth
Bearer token
Body
application/json
Pagination
?cursor=&limit=

Responses

Format
JSON envelope
Success
200 / 201 / 204
Errors
4xx / 5xx + code
Rate limit
X-RateLimit-*

04 / faq

FAQ

Quick answers to the questions teams ask most while integrating.

How do I authenticate my requests?
Send your API key as a bearer token in the Authorization header. Keys are scoped per project; rotate them from the dashboard at any time.
Is there a sandbox environment?
Yes. Use the sandbox base URL with test keys for development. Data is isolated from production and reset periodically.
How is the API versioned?
Versions live in the URL path (e.g. /v1). Breaking changes ship only in new major versions, announced at least 6 months ahead.
How should I handle errors?
Errors return standard HTTP status codes with a JSON body containing code and message. Retry 429 and 5xx responses with exponential backoff.
What's the fastest way to get started?
Create a project, copy a sandbox key, and make your first call from the Endpoints reference. Most teams are live in under ten minutes.