Raw API Access - Uncloud

The CLI and the console are both clients of the same REST API. When an endpoint has no command of its own — because it is new, or too specialised to deserve one — uncloud api reaches it with the credentials you already have.

uncloud api METHOD PATH [key=value… | @body.json | -]

uncloud api GET /api/v1/dashboard/stats
uncloud api GET /api/v1/quotas
uncloud api POST /api/v1/projects name=staging
uncloud api PATCH /api/v1/apps/app_08754a47 replicas=3
uncloud api DELETE /api/v1/volumes/vol_abc123

The method is case-insensitive and the leading / on the path is optional. Authentication, the project header, error formatting, and -json all behave exactly as they do for every other command.

Bodies

Bodies are built the same way as create and update — see building a request body. Values are type-coerced, dotted keys nest, and a whole body can come from a file or stdin:

uncloud api POST /api/v1/apps name=api image_url=nginx:latest port=80 env.TZ=UTC
uncloud api POST /api/v1/apps @app.json
cat app.json | uncloud api POST /api/v1/apps -

Endpoints

Every route under /api/v1 is reachable. The main groups:

Path	Holds
`/apps`	Apps, deploys, logs, domains, secrets
`/databases`	Managed databases and credentials
`/droplets`	VMs, snapshots, console, power actions
`/volumes` `/storage/buckets`	Block and object storage
`/clusters` `/cluster/providers`	Clusters, nodes, providers
`/pipelines` `/cronjobs`	Delivery and scheduled jobs
`/backup/policies` `/backup/jobs`	Backup policies and runs
`/iam/users` `/iam/roles` `/iam/groups`	Access control
`/webhooks` `/event-rules`	Outbound notifications
`/api-tokens` `/ssh-keys`	Credentials
`/integrations/github`	Repository connections
`/plans` `/regions` `/images` `/nodes`	Catalog and inventory
`/events` `/audit` `/dashboard/stats`	Observability

Health is GET /health and needs no token. Ids are prefixed by type: app_, dpl_, db_, vol_, proj_, key_, tok_. Full request and response schemas are in the API Reference.

Scripting

-json makes any call machine-readable:

# every app that is scaled past one replica
uncloud -json api GET /api/v1/apps | jq -r '.apps[] | select(.replicas > 1) | .name'

# scale everything down for the weekend
for id in $(uncloud -json apps list | jq -r '.apps[].id'); do
  uncloud api PATCH /api/v1/apps/$id replicas=1
  uncloud api POST /api/v1/apps/$id/deploy
done

uncloud api sends exactly what you ask, including DELETE. Unlike uncloud <resource> delete, it does not prompt for confirmation — the raw layer assumes you meant it.

Talking to another control plane

Point at a different API for one command without touching your saved config:

UNCLOUD_API_URL=http://localhost:8080 UNCLOUD_API_TOKEN=tok_dev \
  uncloud api GET /api/v1/apps

​Bodies

​Endpoints

​Scripting

​Talking to another control plane

Bodies

Endpoints

Scripting

Talking to another control plane