Docs v1.4 · REST API

Everything you need to integrate the Cloud API

A single reference for authenticating, calling endpoints, and shipping production integrations. Structured for scanning, written for engineers who want answers, not marketing.

Get your API key Browse endpoints

request.sh

curl -X POST https://api.cloudplatform.dev/v1/messages \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to": "user_412", "template": "welcome"}'

RESTful & predictable: JSON in, JSON out, with consistent resource naming across every endpoint.
Token-based auth: Scoped API keys and short-lived tokens, issued and rotated in seconds.
99.99% uptime: Global edge infrastructure with real-time status reporting.

02 · Authentication

Authenticate every request with a bearer token

Every request to the API must carry a valid bearer token in the Authorization header. Tokens are issued in exchange for an API key generated from your dashboard and expire after 60 minutes, so most clients request a fresh token as part of their startup routine.

Get authenticated in four steps

01
Generate an API key
Create a key from the API Keys panel in your dashboard. Each key is scoped to a single project and environment.
02
Exchange it for a token
POST the key to /v1/auth/token to receive a short-lived bearer token.
03
Attach the Authorization header
Send Authorization: Bearer <token> with every request to the API.
04
Refresh before it expires
Tokens expire after 60 minutes. Request a new one proactively to avoid failed calls mid-session.

Protect your credentials

Never hardcode API keys or tokens in client-side code or public repositories.
Store credentials in environment variables or a secrets manager, not in config files.
Scope keys to the minimum permissions required for each integration.
Rotate keys periodically and revoke any that are no longer in use.
Monitor key activity in the dashboard logs to catch unexpected usage early.

Example request

Attach the token as a bearer credential in the Authorization header of every call.

bash

curl -X POST https://api.cloudplatform.dev/v1/data \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "status"}'

Overview API Endpoints

API Reference

Endpoints

Every resource group follows the same predictable REST conventions—JSON payloads, standard status codes, and cursor-based pagination. Browse the core groups below to find the calls you need.

Base URL https://api.cloudplatform.dev

Projects

Create and manage the projects that scope your API keys, environments, and resources.

/v1/projects

GET/v1/projectsList all projects in your account
POST/v1/projectsCreate a new project
GET/v1/projects/{id}Retrieve project details
PATCH/v1/projects/{id}Update project settings
DELETE/v1/projects/{id}Permanently delete a project

Usage

Track consumption, quota thresholds, and billing-relevant metrics per project.

/v1/usage

GET/v1/usageGet aggregate usage summary for the account
GET/v1/usage/{project_id}Get usage metrics for a specific project
GET/v1/usage/limitsRetrieve current plan quotas and thresholds

Deployments

Trigger, monitor, and roll back deployments across your environments.

/v1/deployments

GET/v1/deploymentsList deployments across environments
POST/v1/deploymentsTrigger a new deployment
GET/v1/deployments/{id}Get deployment status and logs
POST/v1/deployments/{id}/rollbackRoll back to a previous deployment

Webhooks

Subscribe to real-time events and manage delivery endpoints for your integrations.

/v1/webhooks

GET/v1/webhooksList configured webhook subscriptions
POST/v1/webhooksCreate a new webhook subscription
PATCH/v1/webhooks/{id}Update webhook URL or event filters
DELETE/v1/webhooks/{id}Remove a webhook subscription

Need help authenticating requests or handling errors?

Authentication guide → Read the FAQ →

FAQ · Developer Support

Frequently Asked Questions

Answers to the questions developers ask most often when integrating with our REST API — covering rate limits, authentication errors, versioning, sandbox testing, and support channels.

Rate Limits What are the API rate limits?

Default plans allow 120 requests/minute per API key. Every response includes X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers so you can throttle client-side. Per-route limits are documented in Endpoints.

Rate Limits What happens if I exceed the rate limit?

Requests beyond the limit receive a 429 Too Many Requests response with a Retry-After header indicating the wait time in seconds. Implement exponential backoff for retries; sustained overages may trigger a review of your account's rate tier.

Authentication Why do I get a 401 Unauthorized error?

This usually means the Authorization header is missing, malformed, or the token has expired. Confirm you're sending Authorization: Bearer <token> and that the key hasn't been revoked — sandbox tokens will not authenticate against production. Full setup steps live in the Authentication guide.

Versioning How does API versioning work?

Every endpoint is namespaced by version, e.g. /v1/, so breaking changes ship under a new version instead of mutating existing behavior. Previous major versions remain supported for at least 12 months after a new release, with deprecation notices sent via email and the X-Api-Deprecated response header.

Sandbox & Testing Is there a sandbox environment for testing?

Yes. Sandbox keys, prefixed sk_test_, point to a mirrored environment that replicates production behavior without side effects like billing or live webhook delivery. Validate your integration in sandbox before switching to live keys.

Support How do I get help or report a bug?

Start with the Endpoints and Authentication guides. Still stuck? Reach our developer support team using the contact details in the footer, and include the X-Request-Id from the failing response to speed up debugging.