Get a shell session record

GET

/api/sessions/{session_id}

Return the metadata for a single session.

Returns 404 if the session does not exist or does not belong to this org. Never returns secrets (client_ip, user_agent, recording details).

Authorizations

HTTPBearer

Parameters

Path Parameters

session_id

required

string format: uuid

Query Parameters

organization_id

required

string format: uuid

Responses

200

Successful Response

Public representation of a shell session.

Secret / sensitive fields (client_ip, user_agent, recording_uri, recording_sha256) are intentionally EXCLUDED from this schema.

WebSocket connection fields (ws_url, ws_token, ws_expires_at) are populated only when the gateway is configured and the session was opened via POST /devices/{id}/sessions. They are None in list/get responses and in dev environments where the gateway is not running.

ws_token is included so the browser can supply it as a WebSocket subprotocol (Sec-WebSocket-Protocol) when opening ws_url — never appended to the URL query string, so it does not land in proxy access logs (GAP-FE-007). It is short-lived (~60 s) and single-use; do NOT persist it.

object

created_at

required

string format: date-time

device_id

required

string format: uuid

ended_at

required

Any of:

string
null

string format: date-time

exit_reason

required

Any of:

string
null

string

required

string format: uuid

justification

required

Any of:

string
null

string

organization_id

required

string format: uuid

recording

boolean

started_at

required

Any of:

string
null

string format: date-time

status

required

string

tier

required

string

user_id

required

Any of:

string
null

string format: uuid

ws_expires_at

Any of:

string
null

string format: date-time

ws_token

Any of:

string
null

string

ws_url

Any of:

string
null

string

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string