VPS details
GET/vms/:vm_id
Returns resources, location, OS, addresses, payment term and auto-renewal. Original VPS passwords and SSH keys are not returned.
Request rules and errors · Lifecycle · 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.
Rescue state. active means a saved Rescue context, not guaranteed SSH availability. access is ssh, console or null. requires_review calls for state verification; operation_id and operation_status refer to the Rescue operation. null means no state was returned.
Application snapshot for this installation, or null when absent. Contains the public catalog metadata and installer_sha256, a checksum of the saved installer, never its contents or credentials. For an order, this is the purchase snapshot; VPS details/list reflect the latest successful installation.
login is the actual installation user, normally admin for Windows or root for Linux; null means the login is unknown. Passwords are not returned.
platform, cpu_display_name and cpu_max_frequency_ghz describe the physical CPU of the VPS current node and can be null when unknown. After migration, subsequent list/detail requests reflect the new node. cpu_display_name is the stored model text and may include physical core/thread counts; allocated VPS resources are defined by cpu_cores. Maximum frequency is CPU metadata, not a live measurement or a guaranteed frequency per vCPU. Read these fields from VPS lists/details, not creation events or operation results.
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
- 200
- 401
- 403
- 404
- 409
- 422
- 500
- 503
Successful response
Missing or invalid key, mismatched ID, or inactive integration
Client IP is not in the integration allowlist (ip_not_allowed).
Resource not found in this integration
Business or state conflict; inspect detail
Invalid request fields or unsupported parameters
Unexpected server error
Service unavailable or result unconfirmed; for a mutation retain its idempotency key