E2e2b-dev
sandboxes

Sandbox

Changed on

Get a sandbox by id

get/sandboxes/{sandboxID}

Request

  • Base URL
    https://api.e2b.app
  • URL
    https://api.e2b.app/sandboxes/{sandboxID}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer and API key in header X-Team-ID
    • or API key in header X-Admin-Token and API key in header X-Team-ID
    • or HTTP bearer and API key in header X-Team-ID

Path parameters

sandboxIDstring required

Response

Successfully returned the sandbox

templateIDstring required

Identifier of the template from which is the sandbox created

aliasstring

Alias of the template

sandboxIDstring required

Identifier of the sandbox

clientIDstring required

Identifier of the client

startedAtstring date-time required

Time when the sandbox was started

endAtstring date-time required

Time when the sandbox will expire

envdVersionstring required

Version of the envd running in the sandbox

envdAccessTokenstring

Access token used for envd communication

allowInternetAccessboolean nullable

Whether internet access was explicitly enabled or disabled for the sandbox. Null means it was not explicitly set.

domainstring nullable

Base domain where the sandbox traffic is accessible

cpuCountinteger required

CPU cores for the sandbox

memoryMBinteger required

Memory for the sandbox in MiB

diskSizeMBinteger required

Disk size for the sandbox in MiB

metadataunknown
state'running' | 'paused' required

State of the sandbox

pauseMode'full' | 'filesystem'

What the sandbox's latest pause saved. full saved the filesystem and the memory, and resuming restores the sandbox where it left off. filesystem saved only the filesystem, and resuming reboots the sandbox from disk. Returned for a paused sandbox once its pause has finished, and omitted while it is still pausing.

Changes

  • 99fccbc60e6dRevision changes
    • breaking

      the response property / became nullable for the status

    • info

      the response's property default value true was removed for the status

  • 04ec8eabc7f9Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status