VNC URL

Request instance console

Retrieves the path of the VNC console for the given virtual machine ID by providing the virtual machine ID in the path.

State requirement: This operation requires the VM to be in the ACTIVE or PRE_ACTIVE state.

get/core/virtual-machines/{vm_id}/request-console

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/request-console
  • Auth: API key in header api_key

Path parameters

vm_idinteger required

ID of the vm.

Response

Please wait a few seconds and visit the below link to access your VNC console URL

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

urlstring

Webhook URL Hyperstack calls when the resource changes state.

Example response

{
  "status": true,
  "message": "Please wait a few seconds and visit the below link to access your VNC console URL",
  "url": "/core/virtual-machines/793490/console/2299076"
}

Changes

No recorded changes to this operation across all 1 revision of this API.