Skip to navigation

Create a console endpoint for a virtual machine

Creates a console endpoint URL for accessing the VM console. Returns the console URL and optional websocket URL.

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Path parameters

idstringRequired
ID of the virtual machine

Response

The console endpoint has been created successfully
urlstring

Signed console URL for accessing the VM. Single-use; request a new one if it expires.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error