Skip to navigation
API ReferenceSandboxes

Open an SSH session to a sandbox

Beta
View as Markdown

Short-lived SSH credentials (host, port, one-time password) for a shell or commands in the sandbox. Revoke with DELETE /v1/sandboxes/{sandboxId}/connections/{id}.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

sandboxIdstringRequired

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.
Idempotency-KeystringOptional1-200 characters

Optional retry key for this billable operation. Reusing the same key with the same request replays its stable outcome; credential-bearing results may be freshly issued for the same principal. Reusing it with a different request returns 409.

Request

This endpoint expects an object.
expiresInSecondsintegerOptional60-900Defaults to 900
How long the session may stay open.

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

Created
commandstring

A ready-to-run OpenSSH command.

createdAtdatetime
RFC 3339 timestamp with a UTC offset.
expiresAtdatetime
RFC 3339 timestamp with a UTC offset.
hoststring
SSH host to connect to.
hostKeyFingerprintstring or null

SHA-256 fingerprint of the SSH host key, when published.

idstring
Unique sandboxConnection identifier generated by BCTRL.
object"sandbox_ssh_session"
passwordstring

One-time password, valid for one minute: log in once; the session then lasts until expiresAt.

passwordExpiresAtdatetime
RFC 3339 timestamp with a UTC offset.
portinteger1-65535
sandboxIdstring
Unique sandbox identifier generated by BCTRL.
usernamestring

SSH user name (the session ID).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error