Skip to main content
GET
/
computers
/
{id}
/
vnc-password
Get VNC password
curl --request GET \
  --url https://www.orgo.ai/api/computers/{id}/vnc-password \
  --header 'Authorization: Bearer <token>'
{
  "password": "abc123xyz"
}
Returns the computer password for VNC and terminal WebSocket connections.
This password provides direct access to the computer’s display and terminal. Keep it secure and do not share it publicly.

Path parameters

id
string
required
Computer ID.

Response

password
string
VNC connection password.

Access control

This endpoint is only accessible to:
  • Workspace owners
  • Workspace members
Unauthorized users will receive a 403 Forbidden response.

Example

curl https://www.orgo.ai/api/computers/a3bb189e-8bf9-3888-9912-ace4e6543002/vnc-password \
  -H "Authorization: Bearer $ORGO_API_KEY"

Response

{
  "password": "0a017c595fa7689753a3"
}

Usage

This password is used for:
  1. VNC connections — Pass as the password when connecting via any VNC client
  2. Terminal WebSocket — Pass as the token query parameter when connecting to the Terminal WebSocket
For programmatic control, use the Computer Actions endpoints instead of VNC. For interactive shell access, use the Terminal WebSocket.

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Path Parameters

id
string
required

Computer ID

Response

VNC password

password
string

VNC connection password