Skip to main content
POST
Create a sandbox

Authorizations

Authorization
string
header
required

API token from your CloudBlast account settings. Pass as Authorization: Bearer <token>.

Body

application/json
image_id
integer
required

From GET /sandboxes/images. The image decides the OS, the size and the location.

Example:

3

name
string | null
Maximum string length: 60
Example:

"research-agent"

auto_stop_minutes
integer | null

Minutes without activity before the sandbox is stopped. 0 means never, otherwise from 5 to 43200 (30 days). Leave it out for the default (lifecycle.auto_stop_minutes, 15 unless the platform says otherwise).

Example:

30

auto_destroy_minutes
integer | null

Minutes the sandbox may stay stopped before it is destroyed. -1 means never. 0 means as soon as it stops (ephemeral). Leave it out for the default (lifecycle.auto_destroy_minutes, never unless the platform says otherwise).

Required range: -1 <= x <= 43200
Example:

1440

ephemeral
boolean
default:false

Destroy the sandbox as soon as it stops. The same as auto_destroy_minutes: 0, and it wins over auto_destroy_minutes.

env
object | null

Environment variables, as {"NAME": "value"}. Names use letters, digits and _, do not start with a digit, and are up to 128 characters. Up to 50 variables, 32 KB in all. Values are text. They are stored encrypted, and only the names are shown again.

Example:

Response

Sandbox created. Running when it came from the warm pool, otherwise creating.

data
object