API ReferenceComputer

Create SSH access for a computer asset

Beta

Generate a time-limited SSH access token for a computer asset. Returns a full SSH command and token that can be used to connect to the computer’s underlying VM and run commands. The computer must support SSH access and be in a running state.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

asset_idstringRequired

Request

This endpoint expects an object.
expires_in_minutesinteger or nullOptional1-1440

How long the SSH access token should remain valid, in minutes (1-1440). The environment may cap this lower (see token_expiry_minutes_options on get_ssh_access); omit it to get the environment’s shortest offered lifetime.

Response

Successful Response
commandstring

Full SSH command to connect to the computer (e.g., ‘ssh token@host’)

expires_in_minutesinteger
Number of minutes until the SSH access token expires
tokenstring
SSH access token used for authentication
proxy_commandstring or nullOptional

Alternative SSH command via proxy (only available for admin users)

Errors

401
Unauthorized Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
502
Bad Gateway Error