AMamika
Sandboxes

Create a direct WebSocket SSH session

Changed on
post/api/v0beta1/rigs/{id}/ssh-sessions

Request

  • Base URL
    https://app.amika.dev (the document declares no server; this is the origin it was published from)
  • URL
    https://app.amika.dev/api/v0beta1/rigs/{id}/ssh-sessions
  • Auth
    • HTTP bearer
    • or API key in cookie wos-session

Path parameters

idstring required

Query parameters

sandbox_by'name' | 'id' | 'ref' | 'name_or_id'

How to interpret the sandbox {id} path param: ref/name_or_id (default; matches an id or a name and rejects an ambiguous match with 409 resource_ref_ambiguous), name, or id.

Response

One no-relay SSH transport descriptor.

session_idstring required
transport'direct_ws' required
connect_urlstring uri required
connect_credentialstring required
sandbox_idstring required
ssh_user'amika' required
host_public_keystring required

Changes