Get VPS status & access
get_vps_statusGet full detail for one VPS: status, specs, live VM state/uptime, and access info (host, port, ready-to-paste command; access.method = ssh for Linux, rdp for Windows — port follows the plan: dedicated IP 22/3389, NAT 20000+vmid). ROOT PASSWORD (keyless VPS): call with reveal: true to retrieve it. It is shown ONCE, and only after the VM has finished booting — at that moment the password is applied to the live VM, so it is guaranteed to work. While the VM is still booting the response carries password_pending: true and NO password; just call again with reveal: true in ~30-60s (the one-time reveal is NOT spent until a password is actually returned — no reset or reboot needed). Without reveal, password_available: true means a password is waiting to be revealed. If you supplied an SSH key at order time, log in with that key (no password); access.ssh_ready (Linux) / access.rdp_ready (Windows) is a LIVE probe of the login port: on a fresh order the first boot applies OS updates, so SSH usually opens 1-5 minutes after the VM is running. While it is false the ready-to-paste command is withheld and ready_note + retry_after_seconds tell you to poll again — do not reset, reboot or reinstall during that window. Use reset_password ONLY if the password is lost. Poll this (without reveal) after order_vps to watch provisioning reach active. NAT plans (no dedicated IP): the SSH port shown is an EXTERNAL DNAT port forwarded to the VM internal port 22 (internal_port in the response). If you configure a host firewall, allow the INTERNAL port — ufw allow OpenSSH — NOT the external port, or ufw enable will lock SSH out. See firewall_note in the response. Requires: token. Typical: access.ssh_ready=false right after an order — not an error, poll again after retry_after_seconds.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reveal | No | ||
| service_id | No | Service code as returned by list_vps/order_vps, e.g. "68J67T5" (a plain numeric id is also accepted). |