Skip to main content
Manage sandbox instances that represent running simulators within a playground.

Actions

ActionDescription
listList sandboxes, optionally filtered by playground
createCreate a new sandbox from a simulator
getGet a sandbox by ID
listEventsList recorded events for a sandbox
teardownTear down a sandbox
addDatasetLoad a dataset into a sandbox
removeDatasetRemove a dataset from a sandbox

Parameters

list

ParameterTypeRequiredDescription
playgroundIdstringnoFilter by playground ID

create

ParameterTypeRequiredDescription
simulatorIdstringyesSimulator ID to instantiate

get

ParameterTypeRequiredDescription
idstringyesSandbox ID

listEvents

ParameterTypeRequiredDescription
idstringyesSandbox ID

teardown

ParameterTypeRequiredDescription
idstringyesSandbox ID

addDataset

ParameterTypeRequiredDescription
idstringyesSandbox ID
datasetIdstringyesDataset ID to load

removeDataset

ParameterTypeRequiredDescription
idstringyesSandbox ID
datasetIdstringyesDataset ID to remove

Examples

List sandboxes for a playground

{
  "action": "list",
  "playgroundId": "pg_xyz789"
}

Load a patient dataset into a sandbox

{
  "action": "addDataset",
  "id": "sb_abc123",
  "datasetId": "ds_patients456"
}

List events recorded by a sandbox

{
  "action": "listEvents",
  "id": "sb_abc123"
}