Fork a running or stopped sandbox

POST /v1/sandboxes/{sandbox}/fork

In this build: Works on the simulator or a real VM.

Scope: sandbox.fork

CLI: harebox fork

Send an Idempotency-Key header. A retry with the same key never repeats the action.

Request: `ForkRequest`

Field	Type	Notes
`name`	`string`
`count`	`integer`
`size`	`Size`
`tier`	`Tier`
`region`	`Region`
`include_memory`	`boolean`	Copy running processes as well as disk.
`no_env`	`boolean`
`labels`	`Labels`
`ttl_seconds`	`integer or null`	Auto-stop after this start. Omit to keep the current one; null for none.
`placement`	`string`	One of: `wait`, `fail_fast`, `queue`

Sandbox

Field	Type	Notes
`id` (required)	`string`
`name`	`string`
`state` (required)	`LifecycleState`
`conditions` (required)	`array`
`condition_details`	`object`	Why each condition applies, and for sleep, what is keeping the sandbox awake.
`region` (required)	`Region`
`tier` (required)	`Tier`
`size` (required)	`Size`
`image`	`string`	Base image: ubuntu-24.04.
`location`	`object`	Where the sandbox runs now. Read-only: HareBox places sandboxes itself and may move them on resume.
`created_by`	`string`	The API key that created this sandbox. A key's monthly budget counts what it created.
`project`	`string or null`
`fleet`	`string or null`
`labels`	`Labels`
`environment`	`object or null`
`template`	`string or null`
`forked_from`	`string or null`
`ipv4`	`string or null`
`ipv6`	`string or null`
`subdomain`	`string`
`sleep`	`SleepPolicy`
`deadline`	`string or null`	Absolute stop time. Null means none.
`visibility`	`string`	One of: `private`, `shared`
`capabilities` (required)	`object`	What this sandbox can do right now. Agents should check these rather than infer them.
`hydration`	`object or null`
`simulated`	`boolean`	True when the machine is the labelled simulator rather than a real VM.
`fork_ids`	`array`	All new sandboxes, when a fork asked for a count.
`meter`	`object`
`created_at` (required)	`string`
`ready_at`	`string or null`

Errors follow one format.