Skip to navigation
API Referencesandboxes

Create sandbox

Create a sandbox from an image, with optional resource limits and a lifecycle policy. The response identifies the new sandbox and its initial status; use the returned name with the get and exec endpoints to check readiness or run commands. A sandbox may still be starting when this request returns, so check its status before depending on work inside it.

Headers

X-Islo-Api-VersionstringRequired

Request

This endpoint expects an object.
cache_keystring or nullOptional
disk_gbintegerOptional>=0
envmap from strings to strings or nullOptional
environmentstring or nullOptional

Environment for sandbox env and environment-owned gateway injection.

gateway_profilestring or nullOptional
imagestringOptional
initobject or nullOptional

Intent-based sandbox init selection.

internet_enabledbooleanOptional
lifecycleobject or nullOptional
memory_mbintegerOptional>=0
namestring or nullOptional
request_idstring or nullOptional
setup_scriptslist of objects or nullOptional
snapshot_namestring or nullOptional
sourceslist of objects or nullOptional
vcpusintegerOptional>=0
workdirstring or nullOptional

Response

Sandbox created
created_atstring
idstring
imagestring
namestring
statusstring
created_bystring or nullOptional
creation_phasestring or nullOptional
deleted_atstring or nullOptional
lifecycleobject or nullOptional
setup_stepslist of objects or nullOptional
specobject or nullOptional
workdirstring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
503
Service Unavailable Error