Skip to main content

Console link

POST 

/vms/:vm_id/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.

Request rules and errors · Lifecycle · Webhooks

For Windows this link opens the graphical desktop with keyboard and mouse support. Use this graphical console, not the serial terminal. This is not an RDP link.

Request​

Responses​

Successful response

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