Resource Commands

Beyond the daily loop, every resource the control plane exposes is a command with the same shape:

uncloud <resource> list
uncloud <resource> get ID
uncloud <resource> create key=value…
uncloud <resource> update ID key=value…
uncloud <resource> delete ID

Not every resource supports all five — the table at the bottom of this page says which. Run a resource with no subcommand to see its verbs:

uncloud droplets

Verb aliases

Type whichever comes naturally:

Verb	Also accepted
`list`	`ls`
`get`	`show`
`create`	`new`, `add`
`update`	`set`, `patch`
`delete`	`rm`, `destroy`

Building a request body

create and update take key=value pairs. Values are decoded rather than passed as strings, so replicas=2 is a number and active=true is a boolean:

You write	It sends
`name=api`	`"name": "api"`
`replicas=2`	`"replicas": 2`
`active=true`	`"active": true`
`note=null`	`"note": null`
`env={"A":"b"}`	`"env": {"A": "b"}` — parsed as JSON
`env.DB_HOST=db:5432`	`"env": {"DB_HOST": "db:5432"}` — dots nest

Repeat a dotted key to build up an object:

uncloud apps create name=api image_url=nginx:latest port=80 \
  env.NODE_ENV=production env.LOG_LEVEL=info

For a body too large for one line, read it from a file or stdin:

uncloud apps create @app.json
cat app.json | uncloud apps create -

Deleting

Deletes ask before they act, and refuse rather than assume when nothing can answer:

uncloud volumes delete vol_abc123
# Delete volume vol_abc123? [y/N]:

uncloud volumes delete vol_abc123 -y     # scripts and CI

The resources

ID is the positional argument for every resource except buckets, which are addressed by NAME.

App platform

Command	Aliases	Verbs
`apps`	`app`	list, get, create, update, delete, plus `deploy` `restart` `status` `logs` `build-log` `pods` `events` `metrics` `deployments` `url` `audit` `secrets`
`templates`	`launch-templates`	list, get, create, update, delete
`cronjobs`	`cron`	create

uncloud apps deploy app_08754a47
uncloud apps url app_08754a47
uncloud apps secrets app_08754a47 STRIPE_KEY=sk_live_…
uncloud apps update app_08754a47 replicas=3

Compute

Command	Aliases	Verbs
`droplets`	`droplet`, `vms`, `vm`	list, get, create, update, delete, plus `actions` `console` `metrics` `events` `snapshots` `snapshot`
`clusters`	`cluster`	list, get, create, delete, plus `nodes`
`nodes`	—	list
`plans`	—	list, create
`regions`	—	list
`images`	—	list, create

uncloud droplets create name=web-1 plan_id=s-2vcpu-2gb region=nyc1 image_id=ubuntu-22-04
uncloud droplets actions dpl_abc123 type=reboot
uncloud droplets snapshot dpl_abc123 name=before-upgrade
uncloud clusters nodes cluster-1

update on a droplet resizes it.

Storage

Command	Aliases	Verbs
`volumes`	`volume`	list, get, create, delete
`buckets`	`bucket`	list, create, delete, plus `objects` — addressed by `NAME`

uncloud volumes create name=data size_gb=50 region=nyc1
uncloud buckets objects my-bucket

Databases

Command	Aliases	Verbs
`databases`	`database`, and `db` for these verbs	list, get, create, delete, plus `credentials`

uncloud databases create name=app-db db_type=postgresql version=16 \
  plan_id=s-2vcpu-2gb region=nyc1 storage_gb=20 replicas=1
uncloud databases credentials db_abc123

See Databases for uncloud db add and db env, which are scoped to the linked app.

Networking

Command	Aliases	Verbs
`loadbalancers`	`lb`	list, create
`security-groups`	`sg`	list, create

App hostnames live under uncloud domain.

Delivery

Command	Aliases	Verbs
`pipelines`	`pipeline`	list, create, delete, plus `runs` `trigger`
`backups`	`backup`	list, get, create, update, delete, plus `run`
`webhooks`	`webhook`	list, create, update, delete

uncloud pipelines trigger pipe_abc123 branch=main
uncloud backups run bkp_abc123

Access and identity

Command	Aliases	Verbs
`projects`	`project`	list, create
`tokens`	`api-tokens`, `token`	list, create, delete
`ssh-keys`	`keys`, `ssh`	list, create, delete
`users`	`iam-users`	list, create, delete
`roles`	`iam-roles`	list, create, delete
`groups`	`iam-groups`	list, create, delete

uncloud tokens create name=ci
uncloud ssh-keys create name=laptop public_key="ssh-ed25519 AAAA…"
uncloud users create email=dev@example.com role=developer

Observability

Command	Verbs
`events`	list
`audit`	list

uncloud events list
uncloud -json audit list | jq '.entries[] | select(.action == "domain_add")'

​Verb aliases

​Building a request body

​Deleting

​The resources

​App platform

​Compute

​Storage

​Databases

​Networking

​Delivery

​Access and identity

​Observability

Verb aliases

Building a request body

Deleting

The resources

App platform

Compute

Storage

Databases

Networking

Delivery

Access and identity

Observability