Skip to content
Ibby docs
Esc
↑↓navigate↵open⌘Jpreview

Get a sandbox's status

Answers for a stopped sandbox too, with status: stopped.

GET/v1/sandboxes/{id}
Authorization
AuthorizationBearer token (ibk_<public id>_<secret>) · headerrequired

A lane's API key. The lane is taken from the key, never from the request.

Path parameters
idstringrequired

A sandbox id: sbx_ and a random part, at most 64 characters.

max length 64 · matches ^sbx_[0-9A-Za-z]+$
Responses
200

The sandbox.

created_atstring<date-time>required

A UTC time in RFC 3339 form.

idstringrequired

The sandbox id, sbx_....

lifetime_msintegerrequired
namestring | nullrequired

The caller's name, or null.

regionstringrequired
resourcesResourcesrequired

The CPU and memory in effect, after lane defaults.

Show properties
cpunumberrequired
cpu_limitnumberrequired
memory_limit_mibintegerrequired
memory_mibintegerrequired
statusSandboxStatusrequired

pending while the create is in flight, running once it can take calls, stopped once its lifetime or size limit was reached or it was removed. A create that fails leaves no sandbox, so a later GET answers 404.

Allowed:pendingrunningstopped
storeStore | nullrequired

The attached store folder, or null when none was asked for.

Show properties
Any of:
object
key_prefixstringrequired
mount_pathstringrequired
null
null
workdirstringrequired
400

invalid_request: The request does not match the contract.

errorErrorDetailrequired
Show properties
codestringrequired

A stable, machine-readable code. Known codes: env_name_refused, file_not_found, file_too_large, idempotency_mismatch, image_not_built, in_progress, internal_error, invalid_request, lane_limit, name_in_use, not_found, payload_too_large, resources_over_cap, region_mismatch, sandbox_stopped, unavailable, store_prefix_refused, store_unavailable, unauthorized. New codes may be added, so treat an unknown one by its HTTP status.

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

401

unauthorized: The API key is missing, unknown or revoked.

errorErrorDetailrequired
Show properties
codestringrequired

A stable, machine-readable code. Known codes: env_name_refused, file_not_found, file_too_large, idempotency_mismatch, image_not_built, in_progress, internal_error, invalid_request, lane_limit, name_in_use, not_found, payload_too_large, resources_over_cap, region_mismatch, sandbox_stopped, unavailable, store_prefix_refused, store_unavailable, unauthorized. New codes may be added, so treat an unknown one by its HTTP status.

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

404

not_found: No such resource in this key's lane. Another lane's ids are not found either.

errorErrorDetailrequired
Show properties
codestringrequired

A stable, machine-readable code. Known codes: env_name_refused, file_not_found, file_too_large, idempotency_mismatch, image_not_built, in_progress, internal_error, invalid_request, lane_limit, name_in_use, not_found, payload_too_large, resources_over_cap, region_mismatch, sandbox_stopped, unavailable, store_prefix_refused, store_unavailable, unauthorized. New codes may be added, so treat an unknown one by its HTTP status.

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

500

internal_error: The platform failed. A retry may succeed; for a call that creates or writes, retry with the same Idempotency-Key.

errorErrorDetailrequired
Show properties
codestringrequired

A stable, machine-readable code. Known codes: env_name_refused, file_not_found, file_too_large, idempotency_mismatch, image_not_built, in_progress, internal_error, invalid_request, lane_limit, name_in_use, not_found, payload_too_large, resources_over_cap, region_mismatch, sandbox_stopped, unavailable, store_prefix_refused, store_unavailable, unauthorized. New codes may be added, so treat an unknown one by its HTTP status.

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

503

unavailable: A service behind the API could not be reached. Retry after a short wait; for a call that creates or writes, with the same Idempotency-Key.

errorErrorDetailrequired
Show properties
codestringrequired

A stable, machine-readable code. Known codes: env_name_refused, file_not_found, file_too_large, idempotency_mismatch, image_not_built, in_progress, internal_error, invalid_request, lane_limit, name_in_use, not_found, payload_too_large, resources_over_cap, region_mismatch, sandbox_stopped, unavailable, store_prefix_refused, store_unavailable, unauthorized. New codes may be added, so treat an unknown one by its HTTP status.

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

Request
curl -X GET 'https://api.ibby.ai/v1/sandboxes/sbx_7Hc2mQ' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "created_at": "2019-08-24T14:15:22Z",
  "id": "sbx_7Hc2mQ",
  "lifetime_ms": 0,
  "name": "string",
  "region": "string",
  "resources": {
    "cpu": 0,
    "cpu_limit": 0,
    "memory_limit_mib": 0,
    "memory_mib": 0
  },
  "status": "pending",
  "store": {
    "key_prefix": "string",
    "mount_path": "string"
  },
  "workdir": "string"
}

Was this page helpful?