Skip to main content

Buy a VPS

POST 

/vms

Choose a plan, location and OS from the catalog. For a normal installation, supply exactly one of password or ssh_public_key, including in the quote request. The SSH key is a single OpenSSH public-key line (Ed25519, RSA or ECDSA). cpu_percent defaults to 60, months to 1 and auto_renew to false. api_user_id is your own customer identifier.

Send a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.

HTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.

Request rules and errors · Lifecycle · Webhooks

Optional cloud-config JSON object, not a YAML string. Maximum 65536 bytes after server JSON serialization (non-ASCII characters are escaped). users, packages, runcmd and write_files must be arrays when present. Networking, hostname and primary access are managed by the platform. Retain the same object when retrying. Its result is reported separately in guest_initialization; cloud_init contents are not returned in orders or webhooks.

Latest installation result: succeeded means cloud-init finished; failed / cloud_init_failed means custom configuration failed; unknown / guest_initialization_timeout means the result was not confirmed within 15 minutes. failed and unknown do not mean a running VPS was not created: its order may be completed and reinstallation succeeded. null means no result is available. Does not confirm application health.

When resources are unavailable, the order remains processing while waiting for provisioning. Read or cancel its queue at /orders/{order_id}/queue. After issue, order parameters.paid_until is updated from the actual creation result; before issue this date is provisional.

Optional application_id selects an application from GET /reference/applications. Keep os_id and exactly one access method. Do not combine application_id with a non-null cloud_init, including {}. Availability, OS and resource compatibility are checked during provisioning by the server service; Cloud API does not duplicate those checks. A rejected creation is handled by the existing order refund flow. Quotes calculate the VPS price only and do not confirm application compatibility. Applications do not add a separate charge. Keep application_id unchanged when retrying the same Idempotency-Key.

Windows VPS use the same endpoint and an os_id from GET /reference/os. New Windows installations use login admin; Linux uses root. Windows requires password (8–127 characters, at least three of lowercase, uppercase, digits and special characters; no CR, LF or NUL and no login substring). Do not supply ssh_public_key, application_id or non-null cloud_init, including {}. A Windows hostname must be at most 15 characters and cannot contain only digits. OS/template/resource compatibility is checked by the server service during provisioning; a quote does not confirm it. Rejected creation follows the existing order refund flow.

To create a new VPS from a paid backup, supply backup_id instead of os_id. Omit password, ssh_public_key, application_id and cloud_init: OS, programs and access come from the copy. Keep the same api_user_id as the backup owner. The new VPS receives its own addresses and is billed as a normal vm_purchase with the usual plan markup and term discount. Restore itself has no separate fee and shares the 3-per-service/24-hour restore limit. The selected disk must fit all backed-up disks; compatibility is checked by the server service.

Administrative blocks: admin_blocked_at and admin_block_reason are separate from status. Renewal does not unblock or start the server. Restrictions and errors: administrative blocks.

Request​

Responses​

Accepted for processing

© 2026 AdaptGroup LLC. All rights reserved.
30 N Gould St Ste R, Sheridan, WY 82801, USA
Back to top