Skip to main content
POST
Fork sandbox

Authorizations

X-API-Key
string
header
required

Path Parameters

sandboxID
string
required

Body

application/json
timeout
integer<int32>
default:15

Time to live for the new forked sandboxes in seconds.

Required range: x >= 0
count
integer<int32>
default:1

Number of forked sandboxes to create. All forks boot from the same snapshot, so the snapshot is captured once regardless of count. Each fork succeeds or fails independently; the outcome of each is reported in its entry of the response list.

Required range: 1 <= x <= 100

Response

The sandbox was snapshotted and the forks were attempted; each entry reports one fork's outcome

sandbox
object
error
object