Documentation
Everything you need to build on the platform
Guides, references, and examples for deploying services, managing data, and automating your workflow.
Search guides, CLI commands, and API endpoints
Install the CLI
npm install -g @cloud/clipnpm add -g @cloud/clibrew install cloud-cliBrowse
Browse the docs
Start with the basics or jump straight to the reference you need.
Getting started
Deploy your first service in minutes.
Deploys
Builds, rollbacks, and preview environments.
Databases
Managed Postgres, caches, and backups.
Quickstarts
Pick your stack
Step-by-step guides that take a new project from an empty repository to a live URL.
API
Deploy with the API
Trigger deploys, scale services, and read logs from scripts, CI jobs, or your own tools.
- Scoped tokens for every project
- Webhooks for deploy and incident events
- Same endpoints the dashboard uses
# Start a deploy of the main branch
curl https://api.example.com/v1/deploys \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"service": "web-frontend", "branch": "main"}'// Start a deploy from a script or CI job
const res = await fetch("https://api.example.com/v1/deploys", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.API_TOKEN}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ service: "web-frontend", branch: "main" }),
});
const deploy = await res.json();# Start a deploy from Python
import os
import requests
res = requests.post(
"https://api.example.com/v1/deploys",
headers={"Authorization": f"Bearer {os.environ['API_TOKEN']}"},
json={"service": "web-frontend", "branch": "main"},
)
deploy = res.json()// Start a deploy from a Go service
body := strings.NewReader(`{"service": "web-frontend", "branch": "main"}`)
req, _ := http.NewRequest("POST", "https://api.example.com/v1/deploys", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("API_TOKEN"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Response201 Created
{
"id": "dep_7f2a91",
"object": "deploy",
"service": "web-frontend",
"branch": "main",
"status": "queued",
"created_at": "2026-10-11T09:24:13Z",
"url": "https://web-frontend-7f2a91.example.app"
}Help