Skip to main content
The verial sandboxes commands manage Sandboxes — running instances of a single simulator, optionally attached to a dataset. A sandbox gives you live credentials (e.g. a FHIR base URL, payer portal_url, SFTP host) you can point an agent at for focused testing. Authentication is required. See verial auth.

​
Subcommands

CommandDescription
verial sandboxes listList sandboxes in your organization.
verial sandboxes createProvision a sandbox from a simulator.
verial sandboxes getGet a single sandbox by ID.
verial sandboxes teardownTear down a sandbox and release its resources.
verial sandboxes eventsList a sandbox’s event stream.
verial sandboxes add-datasetAttach a dataset to a sandbox.
verial sandboxes remove-datasetDetach a dataset from a sandbox.

​
verial sandboxes list

List sandboxes visible to your organization. Supports cursor pagination and filtering by playground. Synopsis: 
verial sandboxes list [--playground-id <id>] [--cursor <cursor>] [--limit <n>]
Options:
FlagDescriptionDefault
--playground-id <id>Only return sandboxes in this playground.—
--cursor <cursor>Pagination cursor returned from a prior page.—
--limit <limit>Items per page.Server default
REST equivalent: GET /sandboxes.

​
verial sandboxes create

Provision a sandbox from a simulator. For portal/payer simulators the response includes a portal_url credential the agent can open directly. Synopsis: 
verial sandboxes create --simulator-id <id> [--dataset-id <id>]
Options:
FlagDescriptionRequired
--simulator-id <id>Simulator to provision.Yes
--dataset-id <id>Optional dataset to attach at creation time.No
Example: 
verial sandboxes create \
  --simulator-id sim_clxyz789 \
  --dataset-id ds_clxyz001
REST equivalent: POST /sandboxes.

​
verial sandboxes get

Fetch a single sandbox, including its credentials and attached datasets. Synopsis: 
verial sandboxes get --id <id>
Example: 
verial sandboxes get --id sbx_clxyz123
REST equivalent: GET /sandboxes/:id.

​
verial sandboxes teardown

Tear down a sandbox: release leased resources (phone numbers, FHIR store, portal session) and mark it inactive. Synopsis: 
verial sandboxes teardown --id <id>
REST equivalent: DELETE /sandboxes/:id.

​
verial sandboxes events

Stream the event log for a sandbox, most recent first. Events record every inbound/outbound interaction (FHIR request, fax send, portal submission, etc.). Synopsis: 
verial sandboxes events --id <id> [--cursor <cursor>] [--limit <n>]
Example: 
verial sandboxes events --id sbx_clxyz123 --limit 50
REST equivalent: GET /sandboxes/:id/events.

​
verial sandboxes add-dataset

Attach a dataset to an existing sandbox. A child dataset is branched so the sandbox’s changes don’t mutate the original. Synopsis: 
verial sandboxes add-dataset --id <id> --dataset-id <datasetId>
REST equivalent: POST /sandboxes/:id/datasets.

​
verial sandboxes remove-dataset

Detach a dataset from a sandbox. Synopsis: 
verial sandboxes remove-dataset --id <id> --dataset-id <datasetId>
REST equivalent: DELETE /sandboxes/:id/datasets/:datasetId.

​
Next Steps

Sandboxes

Sandbox lifecycle, credentials, and events.

Simulators

Define the simulator a sandbox provisions.