Computers
Get VNC password
Get the credentials used to connect to a computer.
GET
Get VNC password
Returns the computer’s VNC credential and its Desktop API token.
Path parameters
Computer UUID. This endpoint accepts the UUID only. Unlike the lifecycle endpoints, it does not resolve an
instance_id, and passing one returns 500.Response
The VNC credential. Use it as the password for a VNC client and as the
token query parameter on the VNC, terminal, events and audio WebSockets.The Bearer token for the computer’s Desktop API. Usually the same string as
password, but a computer that carries its own stamped token returns that instead, so send this field to the Desktop API rather than reusing password. The WebSockets take password, not this field.Access control
Workspace owners and members with Full access can read these values. Can chat members cannot. A workspace-scoped API key can only read them for computers in its own workspace. Each of these refusals answers403, as listed in Errors.
Example
Response
Usage
- VNC connections: pass
passwordas the password in any websockify-compatible VNC client, such as noVNC. - VNC, terminal, events and audio WebSockets: pass
passwordas thetokenquery parameter (see the Terminal WebSocket). - Desktop API through Orgo: send your API key or
passwordas the Bearer token onhttps://www.orgo.ai/api/desktops/{id}/proxy/{endpoint}, with the computer’sid. Orgo swaps an API key for the computer’s credential before forwarding.
Errors
Authorizations
Response
The computer's credentials