Skip to main content
A sandbox is listed, read, and updated through these operations. None of them moves it between its states.

List

GET /sandbox lists sandboxes, newest first, 20 per page and at most 100. The filters are name, state, which repeats, tag[<key>], and swarm. Without state, terminated sandboxes are omitted, and they stay readable for at least 30 days. The control plane lists every region’s sandboxes, and a region’s data plane lists its own. See Regions. telnyx-edge sandbox-cpu list filters by --name, --state, and --region.

Read

GET /sandbox/{id} returns one sandbox. A sandbox of another organization is 404. The response below shows a few of its fields.
Output
The object carries the sandbox’s parts, its state, and its lifetime. env and rules keep their markers, never secret values, and registry_secret is never returned. telnyx-edge sandbox-cpu get reads one sandbox by ID or name, as a table or as JSON with --json.

Update

PATCH /sandbox/{id} replaces the whole tag set with {"tags": {...}}, and {} clears it. An update changes tags only, and is accepted on a terminated sandbox. The outbound policy and the timeout have their own requests, /network and /timeout.