Create a sandbox
Synchronous: waits up to 10 seconds for the sandbox to start and answers with the sandbox as it is by then, usually running. A sandbox that could not be started is answered too, with status failed and a statusReason. 400 image_not_found, 400 for a bot the organization doesn't have, 403 access_denied naming bots.pass, 403 image_access_denied, 409 quota_exceeded.
https://sandboxes.ezghcloud.com/v1/organizations/{orgId}/projects/{projectId}/sandboxesAuthorization
Path parameters
Header parameters
Request bodyJSONrequired
- vpcoptionalobject | null
Reach a VPC: its connections into the VPC come from an address in the subnet, and its internet traffic goes through the VPC's NAT gateway (IPv4 only). Nothing in the VPC can connect to the sandbox. Needs network.subnets.get on the subnet, a subnet of the sandbox's project. Null, the default, reaches only the internet.
Returns
201
The sandbox.
- memoryRestoredboolean | nullrequired
Whether its last start, resume or restart carried its processes on (true: a resume that restored its memory) or started it again from its disk (false: a start after a stop, a restart, or a resume that could not restore its memory). Null until the first one after its creation.
- statusReasonstring | nullrequired
Why it has its status, when there is something to say: idle, drain, host_lost, host_rebooted, suspend_failed, no_capacity, vpc_unavailable, image_prepare_failed, start_failed, reboot_loop, guest_halted, snapshot_unusable, interrupted or operator_hold (EZGH stopped it, and it can't be started or resumed until support lifts the hold); clients treat others as unknown.
400
invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.
403
access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.
404
not_found: unknown, malformed, or in an organization the caller isn't in.
409
quota_exceeded (an allocation quota, with quota), idempotency_conflict, idempotency_in_progress (with Retry-After), organization_deletion_pending, operation_in_progress, or the endpoint's own 409 codes.
413
payload_too_large: the body is over the endpoint's limit (1 MiB unless it says otherwise).
429
too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.
500
internal_error: a bug; the details are in the logs, under the request ID.