compose_run API
compose_run API
compose_run platform API for managing containerized deployments
Tags
Organizations
Protected organization and membership management endpoints
Projects
Project management endpoints (CRUD)
Stacks
Stack management endpoints (CRUD, deploy, stop, resume) — stacks live inside projects
Secrets
Encrypted stack secrets management (envelope encryption via KMS)
Ports
Stack port expose management
DNS
DNS domain management — create domains with TLS, list, delete
Proxy
HTTP reverse proxy — wire a DNS domain to an exposed port
API Keys
Org-scoped API keys (used by user-facing webhooks, docker registry login, etc.)
Registries
External container registry credentials stored per-org and OCI realm authentication
Metrics
VM metrics for projects (historical buckets and live sample)
Logs
Stack runtime logs proxied from the infra
Billing
Read-only wallet endpoints — balance, lots, ledger, usage. Available even when org is suspended.
Volumes
Named-volume management under a stack — inspect, backup/restore, scheduled backup config, and seed (upload / inline / file write).
Domain Zones
Per-org wildcard domain-zone ownership — claim a base domain (TXT-verified) so its subdomains can be attached to stacks.
Webhooks
User-facing redeploy trigger for CI/CD and external integrations.
Domains
Consolidated domain provisioning — atomically creates port + DNS + reverse proxy in a single call.
Security Schemes
cookieAuth
JWT token stored in cookie. Required for protected endpoints.
apiKey
bearerAuth
Org-scoped API token passed as
Authorization: Bearer <api_key>.
Accepted on org and project resource endpoints as an alternative to the
JWT cookie. The key must carry the all scope to grant general API
access, and write permission for any mutating (POST/PUT/PATCH/DELETE)
request. Not accepted on API-key management endpoints.http
