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.
Request
Responses
- 200
- 401
- 404
- 409
- 422
- 500
- 503
Successful response
Missing or invalid key, mismatched ID, or inactive integration
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