Skip to content

Mark a shell session as ended (gateway callback).

POST
/api/internal/sessions/{session_id}/ended

Called by the tunnel gateway when a PTY session closes (normal exit, timeout, disconnect, or forced close). Transitions the session status to ended and appends a session.ended audit event in the same transaction. Idempotent: a second call for an already-ended session returns HTTP 409. Auth: X-Gateway-Token (shared secret).

Parameters

Path Parameters

session_id
required
string format: uuid

Header Parameters

x-gateway-token
Any of:
string

Request Body required

Request body for POST /internal/sessions/{session_id}/ended.

object
ended_at
Any of:
string format: date-time
exit_reason
required

Machine-readable exit reason: ‘normal’ | ‘timeout’ | ‘disconnect’ | ‘forced_close’ | ‘agent_exited’ | ‘agent_crashed’ | ‘gateway_failover’ | ‘transport_lost’.

string
<= 32 characters

Responses

200

Successful Response

object

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string