- Method:
GET
- Path:
/v1/orgs/{org}/compute/vms/{vm_id}/console
- Operation ID:
collectConsole
- Tag: Compute
Send Authorization: Bearer <credential>. The credential is either an API key (vsk_…) created for an organization, or an OIDC access token obtained by signing in to VirtScale.
| Name |
Type |
Required |
Description |
vm_id |
string (uuid) |
Yes |
VirtScale instance id |
org |
string (uuid) |
Yes |
The organization’s id. |
| Name |
Type |
Required |
Description |
operation |
string (uuid) |
Yes |
The id of the operation created by the earlier POST to this same path, which requests a console. Pass the id from that response’s operation object (its type reads vm.console, the same value GET /v1/orgs/{org}/operations shows for it). A console URL can be collected once: an id that is unknown, already collected, expired, or for a different instance returns 404. |
| Field |
Type |
Required |
Enum |
Description |
console_type |
string |
Yes |
|
|
expires_in_seconds |
integer |
Yes |
|
|
url |
string |
Yes |
|
|
Every error response is application/problem+json (schema Problem).
| Status |
Meaning |
| 400 |
The request is malformed or failed validation. |
| 401 |
The credential is missing or invalid. |
| 404 |
The resource does not exist. |
| default |
Any other status is possible; the code field identifies the error. |
curl "https://api.virtscale.nl/v1/orgs/$ORG_ID/compute/vms/$VM_ID/console?operation=$OPERATION" \
-H "Authorization: Bearer $VIRTSCALE_API_KEY"