Close a VM console session

DELETE

/compute/console/sessions/:session_id

Closes a workspace-owned console session and invalidates its connection token. 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.

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.

reasonstringOptionalDefaults to closed_by_user

Response

Console session closed successfully.

session_idstring

stateenum

close_reasonstring

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error