Create a sandbox

Makes a fresh sandbox that is deleted at its TTL. With waitMs the answer comes once the sandbox is ready; if that wait fails, a sandbox made without an idempotency key is destroyed. A retry with the same idempotencyKey returns the first sandbox.

Needs the use scope.

Error

A valid request URL is required to generate request examples

201

{
  "id": "<string>",
  "image": "<string>",
  "status": "creating",
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "labels": {},
  "backend": "<string>",
  "owner": "<string>",
  "keyId": "<string>"
}

Authorizations

ticketapiKey

Authorization · string · header · required

The ticket's authorization value, sent as it is (its own scheme, not Bearer), until the ticket's expiresAt.

Body

application/json

image · string · required

The sandbox image.

Pattern: ^[a-z0-9][a-z0-9._-]{0,63}$

ttlMs · integer · required

Time to live in ms (at most 24 h): at the end, the sandbox's tasks are stopped and it is deleted.

Required range: 1 <= x <= 86400000

idempotencyKey · string

Makes a retried create return the first one's answer; the same key with a different request is idempotency_conflict. 1 to 255 printable ASCII characters without spaces (a UUID is fine).

Pattern: ^[\x21-\x7e]{1,255}$

waitMs · integer

Answer once the sandbox is ready, waiting up to this long (1 ms to 24 h).

Required range: 1 <= x <= 86400000

labels · object

Up to 16 string pairs: keys [a-z0-9._-] of at most 63 characters, values of at most 256.

Show child attributes

Response

201

application/json

The sandbox.

id · string · required

The sandbox id.

Pattern: ^sbx_[0-9a-f]{12}$

image · string · required

The image it was made from.

status · enum<string> · required

creating until it can run tasks, then ready.

Available options: creating, ready

createdAt · string<date-time> · required

When it was made.

expiresAt · string<date-time> · required

When it is deleted.

labels · object · required

Up to 16 string pairs: keys [a-z0-9._-] of at most 63 characters, values of at most 256.

Show child attributes

backend · string

The backend that runs it.

owner · string

The caller that made it.

keyId · string

The SHA-256 of the API key that made it (64 lowercase hex), when a key made it.

Pattern: ^[0-9a-f]{64}$