HEhedra-labs
Sandboxes

Open a session on an instance

Changed on

A short-lived session JWT for one instance of an active sandbox, to open Logs streams on the broker at broker_url; PortForward too when the key holds sandboxes:write, and Exec and Invoke when it holds sandboxes:exec. Mint a new one for each stream opened after expires_at.

post/sandboxes/{sandbox_id}/session

Request

  • Base URL
    https://api.hedra.com/v3
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

sandbox_idstring required

The sandbox's id (sandbox_<uuid>).

Query parameters

replicainteger

The instance's replica number, from 0.

Response

Successful Response

tokenstring required

The session JWT.

broker_urlstring required

The broker to open streams on with token, as host:port.

expires_atstring date-time required

When the broker stops accepting token for a new stream. A stream already open keeps running.

replicainteger required

The replica the session is bound to.

Changes