check VNC console status (coming soon)

Returns status of a VNC console session given VM ID.

If VM has no open console, this call will fail.

Authorization

AuthorizationRequiredBearer <token>

OpenScaler API uses OAuth, a standard for secure authorization. To access the API, obtain a token via the OpenScaler Platform.

Use the access_token in the Authorization header for requests:

Authorization: Bearer <token>

Always keep your token secure and do not share it with anyone.

In: header

vm_idRequiredstring

A unique identifier for a VM instance.

curl -X GET "https://api.alpha.openscaler.net/v1/vms/23/console" \
  -H "Authorization: Bearer <token>"

Check Recovery Console Status

{
  "status": "open"
}