A valid request URL is required to generate request examples{
"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>"
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}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.
A valid request URL is required to generate request examples{
"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>"
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}{
"ok": false,
"error": {
"code": "invalid_value",
"message": "<string>"
}
}Authorizations
The ticket's authorization value, sent as it is (its own scheme, not Bearer), until the ticket's expiresAt.
Body
The sandbox image.
^[a-z0-9][a-z0-9._-]{0,63}$Time to live in ms (at most 24 h): at the end, the sandbox's tasks are stopped and it is deleted.
1 <= x <= 86400000Makes 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).
^[\x21-\x7e]{1,255}$Answer once the sandbox is ready, waiting up to this long (1 ms to 24 h).
1 <= x <= 86400000Up to 16 string pairs: keys [a-z0-9._-] of at most 63 characters, values of at most 256.
Show child attributes
Show child attributes
Response
The sandbox.
The sandbox id.
^sbx_[0-9a-f]{12}$The image it was made from.
creating until it can run tasks, then ready.
creating, ready When it was made.
When it is deleted.
Up to 16 string pairs: keys [a-z0-9._-] of at most 63 characters, values of at most 256.
Show child attributes
Show child attributes
The backend that runs it.
The caller that made it.
The SHA-256 of the API key that made it (64 lowercase hex), when a key made it.
^[0-9a-f]{64}$