Cloud servers

How-to guides

Servers 9

Cloud servers you own. Creating one places an order paid from your account balance.

• GET/cloud/serversList cloud servers
• POST/cloud/serversCreate (order) a cloud server
• GET/cloud/servers/{id}Get a server with its live state
• PATCH/cloud/servers/{id}Rename a server or switch auto-renew
• DELETE/cloud/servers/{id}Delete (cancel) a server
• GET/cloud/servers/{id}/disksList the server's additional disks
• POST/cloud/servers/{id}/disksAdd an additional disk
• PUT/cloud/servers/{id}/disks/{disk}Grow an additional disk
• DELETE/cloud/servers/{id}/disks/{disk}Remove an additional disk (with its data)

Server actions 3

Power, rebuild, password and rescue operations. Asynchronous; poll the server until live.locked is false.

• POST/cloud/servers/{id}/actions/{action}Run a server action
• POST/cloud/servers/{id}/consoleOpen a one-time VNC console ticket
• POST/cloud/bulkRun one action on up to 50 servers

Snapshots and backups 6

Point-in-time images of a server disk. Snapshot space is an add-on quota in GB.

• GET/cloud/servers/{id}/snapshotsList snapshots and the snapshot quota
• POST/cloud/servers/{id}/snapshotsTake a snapshot
• POST/cloud/servers/{id}/snapshots/{sid}/restoreRestore a snapshot onto the server (overwrites the disk)
• DELETE/cloud/servers/{id}/snapshots/{sid}Delete a snapshot
• GET/cloud/servers/{id}/backupsList automatic backups
• POST/cloud/servers/{id}/backupsTake a manual backup (backup add-on required)

Networking 12

Reverse DNS and the inbound firewall of a server.

• GET/cloud/servers/{id}/rdnsList reverse DNS entries
• PUT/cloud/servers/{id}/rdnsSet (or reset) the PTR record of one address
• GET/cloud/servers/{id}/firewallInbound firewall rules
• POST/cloud/servers/{id}/firewall/rulesAdd a firewall rule
• DELETE/cloud/servers/{id}/firewall/rules/{n}Remove a firewall rule (the last one needs confirm)
• GET/cloud/servers/{id}/firewall/policyNetwork firewall policy (rules, default action, status)
• PUT/cloud/servers/{id}/firewall/policyReplace the network firewall policy
• DELETE/cloud/servers/{id}/firewall/policyRemove your firewall rules
• POST/cloud/servers/{id}/firewall/policy/confirmMake the running firewall trial permanent
• GET/cloud/servers/{id}/ipsList the server's IPv4 addresses
• POST/cloud/servers/{id}/ipsAdd additional IPv4 addresses
• DELETE/cloud/servers/{id}/ips/{ip}Release an additional IPv4 address

Monitoring 2

CPU, disk and network metrics and the provider-side action history.

• GET/cloud/servers/{id}/metricsCPU, disk and network time series
• GET/cloud/servers/{id}/activityRecent platform actions on the server

SSH keys 4

Account-level public keys you can install on new servers.

• GET/cloud/ssh-keysList SSH keys
• POST/cloud/ssh-keysAdd an SSH key
• GET/cloud/ssh-keys/{id}Get an SSH key
• DELETE/cloud/ssh-keys/{id}Delete an SSH key

Templates 7

Custom templates from your own tr-ist-1 servers (no image upload)

• GET/cloud/templatesList your templates
• GET/cloud/templates/{id}Get a template
• PATCH/cloud/templates/{id}Rename a template
• DELETE/cloud/templates/{id}Delete a template
• POST/cloud/servers/{id}/templatesCapture a server as a template
• POST/cloud/templates/{id}/serversNew server from a template
• POST/cloud/templates/{id}/rebuildReinstall a server from a template

Security groups 11

Reusable allow lists (AWS security group model) for servers with the network firewall add-on. Up to 5 groups per server, evaluated after Gyro rules and your advanced ordered rules; with groups and no advanced rules inbound traffic is denied by default. Rules count against the server's rule allowance. A change that could cut SSH/RDP access runs as a 5 minute trial: confirm it.

• GET/cloud/security-groupsList security groups
• POST/cloud/security-groupsCreate a security group
• GET/cloud/security-groups/{sg}Get a security group
• PATCH/cloud/security-groups/{sg}Rename / describe a security group
• DELETE/cloud/security-groups/{sg}Delete a security group
• PUT/cloud/security-groups/{sg}/rulesReplace the rules of a security group
• POST/cloud/security-groups/{sg}/confirmMake the running rule trial permanent
• GET/cloud/servers/{id}/security-groupsSecurity groups attached to a server
• PUT/cloud/servers/{id}/security-groupsSet the exact list of attached groups
• POST/cloud/servers/{id}/security-groups/{sg}Attach a security group to a server
• DELETE/cloud/servers/{id}/security-groups/{sg}Detach a security group from a server

One-click apps 5

Install a one-click app on a cloud server (the disk is rebuilt).

• GET/cloud/appsList installable apps
• GET/cloud/servers/{id}/appApp install status (credentials shown once when ready)
• POST/cloud/servers/{id}/appInstall an app (rebuilds the disk; confirm required; 3 per server per day)
• GET/cloud/servers/{id}/app/logLive progress log of the latest app install (step changes, server log tail)
• POST/cloud/servers/{id}/app/retryRetry a failed or silent app install (rebuilds the disk; confirm required; 3 per server per hour)

Catalog 6

Orderable products, locations and operating system images.

• GET/cloud/productsList orderable cloud server products
• GET/cloud/locationsList locations with orderable products
• GET/cloud/imagesList operating system images
• GET/productsList products
• GET/products/categoriesList product categories
• GET/products/{id}Get product (path: {id})