Get a sandbox

The sandbox with its current status. Another caller’s sandbox is not_found, the same answer as an unknown id.

Needs the view scope.

Error

A valid request URL is required to generate request examples

200

{
  "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.

Path Parameters

id · string · required

The sandbox id (sbx_ and 12 hex).

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

Response

200

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}$