VPS management
VPS management endpoints for your Cloud API integration.
List VPS
Lists only VPS belonging to this integration. api_user_id filters by your customer identifier. total_count is the full filtered count, before limit/offset.
VPS details
Returns resources, location, OS, addresses, payment term and auto-renewal. Original VPS passwords and SSH keys are not returned.
Power status
Returns current power status and uptime in seconds.
Monitoring
Select the time range and aggregation (AVERAGE or MAX). A null metric means missing data, not zero. Point time is a Unix timestamp; network rates are Mbps, memory is bytes and disk rates are bytes/second.
Traffic usage
Returns the current traffic period, quota, usage and shaping. Byte counters and timestamps describe the last available sample. A missing period or shaping is represented as null.
Console link
Creates a one-time console URL valid until expires_at. api_key_id is a query parameter; there is no JSON body or Idempotency-Key. The response uses Cache-Control: no-store.
Power control
start starts the VPS; shutdown and reboot request a graceful OS shutdown/reboot. stop forces power off; reset forces a restart and can lose unsaved data.
Reset password
Changes the password of an existing OS user (login defaults to root) through the guest agent. A working guest agent is required. A failed or unconfirmed operation does not prove the password remained unchanged: check access before another command.
Reinstall OS
Recreates the system disk and destroys its data. Extra disks are kept unless wipe_extra_disks=true. Supply either a password or SSH public key; omit both to reuse the installation access settings. Both together are invalid. VPS identity, network and paid term are preserved.
Enable Rescue
Reboots the VPS into Rescue while preserving disks and networking. Requires at least 2048 MiB RAM and a paid VPS. Supply a temporary password; after success, connect as root to the VPS IP over SSH on port 22. Firewall rules still apply. Plan changes, OS reinstallation and normal OS password resets are unavailable in Rescue. Check the operation and rescue in VPS details. For rescue_not_ready or requires_review=true, verify the state and exit Rescue; retry a lost request with its original Idempotency-Key.
Disable Rescue
Exits Rescue and restores normal OS boot. A paid VPS is started; an expired or suspended VPS remains stopped. Exit is also allowed from error when Rescue context is saved. Send api_key_id in the query; no request body or password is needed. Use a separate Idempotency-Key for the exit command.
Delete VPS
Permanently deletes the VPS. keep_ips is a required query parameter. true retains IPv4 addresses, including the primary address, as separately billed addresses; false releases them. The result contains held_ips. Unused VPS time is not refunded.
Operation history
Operations and paid orders have different identifiers. Read data.id from a command response as operation_id. queued/running are not completion; succeeded/failed are terminal command results. History may also contain cancelled. result is populated only for successful delete, attach/detach, password reset and reinstall operations; use the status/firewall routes for other current state.
Operation result
Operations and paid orders have different identifiers. Read data.id from a command response as operation_id. queued/running are not completion; succeeded/failed are terminal command results. History may also contain cancelled. result is populated only for successful delete, attach/detach, password reset and reinstall operations; use the status/firewall routes for other current state.