Retrieve API Path For VNC Console

GET https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{id}/request-console

Retrieves the path to be sent in the request for obtaining the link to the VNC console for a specified virtual machine. Include the id of the virtual machine in the request path.

Path parameters

---

id integer   Required

The ID of the virtual machine for which to retrieve the VNC console.

Attributes

---

status boolean

Indicates the success or failure of the request to retrieve the VNC console path for a specified virtual machine. true indicates success, while false indicates an error.

---

message string

A message confirming the successful retrieval of the VNC console request path.

---

url string

The path to be sent in the GET /core/virtual-machines/{virtual_machine_id}/console/{job_id} request to retrieve the link to VNC console.

Example request

curl -X GET "https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{id}/request-console" \
 -H "accept: application/json"\
 -H "api_key: YOUR API KEY" 

Response

{
  "status": true,
  "message": "string",
  "url": "string"
}

Returns

---

Returns the status of the request, where true indicates the successful retrieval of the path to the GET /core/virtual-machines/{virtual_machine_id}/console/{job_id} endpoint in the url field

Back to top