Warning: JavaScript is not enabled or not loaded. Please enable JavaScript for the best experience.
Cloud API Platform logo

Documentation

Cloud API Platform Docs

v2 REST + Webhooks

Build with the Cloud API

Authenticate with short-lived tokens, send JSON requests over HTTPS, and subscribe to event-driven webhooks. Use the navigation to jump between key sections and get productive quickly.

Section

Overview

The Cloud API Platform provides a unified interface for managing resources across projects and environments. It exposes predictable REST endpoints, returns consistent JSON payloads, and is designed for fast integration in CI/CD pipelines and internal tooling.

Key capabilities

  • REST endpoints with resource-first patterns
  • JSON responses with stable field contracts
  • Rate limiting headers for predictable throughput
  • Versioning for forward-compatible upgrades

Core concepts

  • Projects isolate environments and access scopes
  • Tokens authenticate every request
  • Resources are addressable by stable IDs
  • Pagination uses cursor-based tokens
Security Updated March 2026

Authentication

All requests must include an API key for server-to-server authentication. Keys are scoped to your workspace and grant access to the resources your account is authorized to use.

Authorization header

Send your API key in the Authorization header using the Bearer scheme.

HTTP header example text/plain 
Authorization: Bearer YOUR_API_KEY

Environment separation

Test and production environments use distinct API keys. Requests made with a test key never affect live data. Use the correct base URL and key for the environment you are targeting.

Test

Base URL: https://api.test.example.com

Production

Base URL: https://api.example.com

Reference

Endpoints

Core resources are grouped by function with predictable REST patterns and consistent response envelopes.

Projects

/v1/projects

Create, list, and manage API projects. Supports pagination, filtering, and role-based visibility.

GET List projects
POST Create project
PATCH Update project

API Keys

/v1/keys

Issue, rotate, and revoke API keys with scoped permissions and environment restrictions.

GET List keys
POST Create key
DELETE Revoke key

Usage

/v1/usage

Monitor request volume, latency percentiles, and error rates for each workspace.

GET Usage summary
GET Time series
POST Export report

FAQ

Common questions for API integrators

Concise answers to common platform behaviors, limits, and troubleshooting patterns.

Last updated: 2026-03-18

What are the default rate limits?

Requests are limited to 600 per minute per project. Burst traffic is smoothed over a rolling window, and limits are surfaced in response headers for easy monitoring.

How does API versioning work?

Versions are specified in the base path (for example, /v1). We maintain backward compatibility within a major version and deprecate with 90‑day notice.

Is a sandbox environment available?

Yes. Use the sandbox workspace to test with non-production data. Credentials and endpoints mirror production for easy promotion.

How should error responses be handled?

Errors return a standard JSON envelope with code, message, and optional details. Use the HTTP status for quick routing and log the code for support.