Actions
20 actions, callable from the panel, the command palette and the API as
POST /api/v1/a/<id>. Internal actions used between modules are not listed.
| Action | What it does | Risk | Preview |
|---|---|---|---|
cloud.connection.list | Cloud connections (read) | low | No dry run |
cloud.catalog.get | Regions, sizes with prices and images (read) | low | No dry run |
cloud.server.list | List servers (read) | low | No dry run |
cloud.server.get | Show a server (read) | low | No dry run |
cloud.server.create | Create a server | high | |
cloud.server.power | Start, stop or restart a server | medium | |
cloud.server.resize | Change a server's size | high | |
cloud.server.rebuild | Reinstall a server | critical | |
cloud.server.snapshot | Take a snapshot | medium | |
cloud.server.destroy | Destroy a server | critical | |
cloud.server.adopt | Let the panel manage an existing server | medium | |
cloud.volume.list | List volumes (read) | low | No dry run |
cloud.volume.create | Create a volume | medium | |
cloud.volume.attach | Attach a volume to a server | medium | |
cloud.volume.detach | Detach a volume | medium | |
cloud.volume.delete | Delete a volume | high | |
cloud.firewall.list | List firewalls (read) | low | No dry run |
cloud.floating_ip.list | List floating IPs (read) | low | No dry run |
cloud.floating_ip.assign | Point a floating IP at a server | medium | |
cloud.costs.summary | Monthly cost of the managed servers (read) | low | No dry run |
Permissions and limits
Permissions
cloud.viewSee cloud servers, catalogs and costscloud.manageCreate, change and destroy cloud servers and volumes
Engineering notes
Generated from modules/cloud/docs.md at build e0cdf300. These are the notes the engineers keep
next to the code: precise, technical, and honest about what is not done yet.
Create servers at Hetzner, DigitalOcean, Vultr or Akamai (Linode) from the panel. The new server installs the panel's agent by itself and shows up in Cluster. Cloud servers is a paid add-on: without it in your licence the pages are switched off, and the Store shows how to start a trial.
Before you start
- In Providers, add your key for the provider and choose servers as what it is used for. The key is stored encrypted and is never shown again, here or anywhere else. Each provider's page says which token to make.
- Hetzner Cloud: a project API token with Read & Write (this is a different token from Hetzner DNS).
- DigitalOcean: a personal access token with write scope. Vultr: an API key (allow this server's address if you limit it). Akamai: a personal access token with Linodes, Volumes, Images and Firewalls read/write.
- In the Cloud settings, set the pinned agent release: its address and its sha256 checksum (the panel's own
/api/v1/agent/release/<version>/<file>works). New servers download exactly that file and refuse it if the checksum differs. - The panel's public address must be reachable from the new server. If it is not set, Create tells you.
Create a server
Create a server asks, step by step: which connection, where, which size (each size shows its price a month and an hour), which system (Ubuntu or Debian long-term releases), a name and what the server does. The last step shows the monthly cost and then the panel's plan. The provider bills from the moment the server exists until you destroy it.
The enrol token inside the start-up script is valid for one hour and works once; it is readable in the provider's console during that hour.
Manage it
Open a server in the list for: Start, Shut down, Restart, Take a snapshot, Change size (the server restarts; the disk keeps its size so you can go back) and Destroy.
- Only servers the panel made, or ones you let it manage, can be changed. Other servers at the provider are listed read-only; "Let the panel manage it" adopts one.
- Destroy asks for the server's name. If it is a node in Cluster, its accounts are moved away and it leaves Cluster first. If that cannot be done, nothing is deleted.
- Volumes, Firewalls and Floating IPs tabs appear only when the provider offers them. You can delete only volumes made here, and only when they are detached.
Costs
The top of the page adds up the monthly price of the servers the panel manages, per currency. These are the provider's list prices before tax; traffic, snapshots and volumes are billed on top.
What the AI can do
The assistant can read regions, sizes, prices and images and suggest a size. Creating, changing or destroying anything stays a plan that you approve.