Skip to content
pols.so docs
Esc
↑↓navigate↵open⌘Jpreview

How to reach the sandbox over SSH through the gateway

The gateway routes by user name: ssh <sandbox ID>@<gateway>, with a key registered under /v1/ssh-keys. Inside, you are the sandbox user. Agent and port forwarding, scp and sftp work.

GET/v1/sandboxes/{sandbox}/ssh
Authorization
AuthorizationBearer token · headerrequired

Org-scoped API key, pols_....

Path parameters
sandboxstringrequired

Sandbox ID (sbx_...) or name.

Responses
200

The SSH access.

hoststringrequired
portintegerrequired
min 1 · max 65535
userstringrequired

The user name the gateway routes by, the sandbox ID.

commandstringrequired
429

Rate limited (rate_limited): too many requests or failed authentications from this address, too many requests or lifecycle calls for this org, or too many of its exec, file, computer and CDP calls in progress at once. Retry after Retry-After seconds.

errorobjectrequired
Show properties
codestringrequired

Stable machine-readable code: bad_request (400), unauthorized (401), forbidden (403), quota_exceeded (403), not_found (404), conflict (409), rate_limited (429, see Retry-After), internal (500), runtime_error (502, the sandbox host failed), unavailable (503, the feature is not configured on this deployment), timeout (504, or 408 when a request body stalls).

messagestringrequired
default

Error.

errorobjectrequired
Show properties
codestringrequired

Stable machine-readable code: bad_request (400), unauthorized (401), forbidden (403), quota_exceeded (403), not_found (404), conflict (409), rate_limited (429, see Retry-After), internal (500), runtime_error (502, the sandbox host failed), unavailable (503, the feature is not configured on this deployment), timeout (504, or 408 when a request body stalls).

messagestringrequired
Request
curl -X GET 'https://api.pols.so/v1/sandboxes/string/ssh' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "host": "ssh.pols.so",
  "port": 1,
  "user": "sbx_3k9x2m1q8zt4",
  "command": "ssh sbx_3k9x2m1q8zt4@ssh.pols.so"
}