API ReferenceVM Console

Get a VM console session

Returns the status of a workspace-owned console session. Requires scope: vm.read.

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.

Path parameters

session_idstringRequired>=1 character
VM console session ID.

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.

Response

Console session status returned successfully.
session_idstring
vm_idstring
vm_typeenum
console_typeenum
stateenum
host_idstring
host_mgmt_ipstring
socket_pathstring
created_atdatetime
idle_timeout_secondsinteger
max_duration_secondsinteger
organization_idstring or nullOptional
workspace_idstring or nullOptional
workspace_namestring or nullOptional
connected_atdatetime or nullOptional
closed_atdatetime or nullOptional
close_reasonstring or nullOptional
token_expires_atdatetime or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error