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

​
verial sandboxes list

List sandboxes visible to your organization. Supports cursor pagination and filtering by playground. Synopsis:
Options: 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:
Options: Example:
REST equivalent: POST /sandboxes.

​
verial sandboxes get

Fetch a single sandbox, including its credentials and attached datasets. Synopsis:
Example:
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:
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:
Example:
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:
REST equivalent: POST /sandboxes/:id/datasets.

​
verial sandboxes remove-dataset

Detach a dataset from a sandbox. Synopsis:
REST equivalent: DELETE /sandboxes/:id/datasets/:datasetId.

​
Next Steps

Sandboxes

Sandbox lifecycle, credentials, and events.

Simulators

Define the simulator a sandbox provisions.