Stop and remove a sandbox
Stops and removes the sandbox. Removing a stopped sandbox succeeds.
/v1/sandboxes/{id}AuthorizationBearer token (ibk_<public id>_<secret>) · headerrequiredA lane's API key. The lane is taken from the key, never from the request.
idstringrequiredA sandbox id: sbx_ and a random part, at most 64 characters.
Removed.
invalid_request: The request does not match the contract.
errorErrorDetailrequiredShow propertiesHide properties
codestringrequiredA 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.
messagestringrequiredA sentence for a person. Do not parse it.
request_idstringrequiredThe same value as the X-Request-Id header.
unauthorized: The API key is missing, unknown or revoked.
errorErrorDetailrequiredShow propertiesHide properties
codestringrequiredA 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.
messagestringrequiredA sentence for a person. Do not parse it.
request_idstringrequiredThe same value as the X-Request-Id header.
not_found: No such resource in this key's lane. Another lane's ids are not found either.
errorErrorDetailrequiredShow propertiesHide properties
codestringrequiredA 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.
messagestringrequiredA sentence for a person. Do not parse it.
request_idstringrequiredThe same value as the X-Request-Id header.
internal_error: The platform failed. A retry may succeed; for a call that creates or writes, retry with the same Idempotency-Key.
errorErrorDetailrequiredShow propertiesHide properties
codestringrequiredA 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.
messagestringrequiredA sentence for a person. Do not parse it.
request_idstringrequiredThe same value as the X-Request-Id header.
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.
errorErrorDetailrequiredShow propertiesHide properties
codestringrequiredA 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.
messagestringrequiredA sentence for a person. Do not parse it.
request_idstringrequiredThe same value as the X-Request-Id header.