API ReferenceVM Console

Create a VM console session

Creates a short-lived graphical console session for a cloud or GPU VM. The returned connect URL contains an expiring token; do not log or persist it. Requires scope: vm.write.

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Request

This endpoint expects an object.
vm_idstringRequired>=1 character
vm_typeenumOptional
console_typeenumOptionalDefaults to graphical
requested_bystring or nullOptionalDefaults to portal-client-ui
user_idstring or nullOptional

Response

Console session created successfully.
session_idstring
vm_idstring
vm_typeenum
console_typeenum
connect_urlstringformat: "uri"

Sensitive, short-lived console connection URL. Do not log or persist it.

token_expires_in_secondsinteger
idle_timeout_secondsinteger
max_duration_secondsinteger
stateenum
organization_idstring or nullOptional
workspace_idstring or nullOptional
workspace_namestring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error