SandboxesDesktop

Create VNC access token

Generate a short-lived token for WebSocket VNC access to a sandbox.

POST
/v1/sandboxes/{idOrName}/vnc-access
AuthorizationBearer <token>

API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.

In: header

Path Parameters

idOrName*string

Sandbox ID (ULID) or name

Query Parameters

org?string

Required when the path names the sandbox by name.

project?string

Required when the path names the sandbox by name.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

start_desktop?boolean

Start the desktop environment before creating the VNC token

Response Body

application/json

application/problem+json

curl -X POST "https://example.com/v1/sandboxes/string/vnc-access" \  -H "Content-Type: application/json" \  -d '{}'
{  "expires_at": "2019-08-24T14:15:22Z",  "token": "string",  "url": "string"}