> ## Documentation Index > Fetch the complete documentation index at: https://e2b.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get sandbox > Get a sandbox by id ## OpenAPI ````yaml /openapi-public.yml get /sandboxes/{sandboxID} openapi: 3.1.0 info: title: E2B API version: 0.1.0 description: >- Complete E2B developer API. Platform endpoints are served on api.e2b.app. Sandbox endpoints (envd) are served on the shared sandbox host (sandbox.e2b.app); target a specific sandbox with the E2b-Sandbox-Id and E2b-Sandbox-Port headers. servers: - url: https://api.e2b.app description: E2B Platform API security: [] tags: - name: Sandboxes - name: Templates - name: Tags - name: Volumes - name: Envd - name: Filesystem - name: Process - name: Teams paths: /sandboxes/{sandboxID}: servers: - url: https://api.e2b.app description: E2B Platform API get: tags: - Sandboxes summary: Get sandbox description: Get a sandbox by id operationId: getSandbox parameters: - $ref: '#/components/parameters/sandboxID' responses: '200': description: Successfully returned the sandbox content: application/json: schema: $ref: '#/components/schemas/SandboxDetail' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '500': $ref: '#/components/responses/500' security: - ApiKeyAuth: [] components: parameters: sandboxID: name: sandboxID in: path required: true schema: type: string schemas: SandboxDetail: required: - templateID - sandboxID - clientID - startedAt - cpuCount - memoryMB - diskSizeMB - endAt - state - envdVersion properties: templateID: type: string description: Identifier of the template from which is the sandbox created alias: type: string description: Alias of the template sandboxID: type: string description: Identifier of the sandbox clientID: type: string deprecated: true description: Identifier of the client startedAt: type: string format: date-time description: Time when the sandbox was started endAt: type: string format: date-time description: Time when the sandbox will expire envdVersion: $ref: '#/components/schemas/EnvdVersion' envdAccessToken: type: - string - 'null' description: >- Access token for authenticating envd requests to this sandbox. Only returned when the sandbox is created with `secure: true`. Null for non-secure sandboxes (envd endpoints work without auth). allowInternetAccess: type: - boolean - 'null' description: >- Whether internet access was explicitly enabled or disabled for the sandbox. Null means it was not explicitly set. domain: type: - string - 'null' description: >- Deprecated: always null. Construct sandbox URLs as `https://{port}-{sandboxID}.e2b.app`. deprecated: true cpuCount: $ref: '#/components/schemas/CPUCount' memoryMB: $ref: '#/components/schemas/MemoryMB' diskSizeMB: $ref: '#/components/schemas/DiskSizeMB' metadata: $ref: '#/components/schemas/SandboxMetadata' state: $ref: '#/components/schemas/SandboxState' network: $ref: '#/components/schemas/SandboxNetworkConfig' lifecycle: $ref: '#/components/schemas/SandboxLifecycle' volumeMounts: type: array items: $ref: '#/components/schemas/SandboxVolumeMount' type: object EnvdVersion: type: string description: Version of the envd running in the sandbox CPUCount: type: integer format: int32 minimum: 1 description: CPU cores for the sandbox MemoryMB: type: integer format: int32 minimum: 128 description: Memory for the sandbox in MiB DiskSizeMB: type: integer format: int32 minimum: 0 description: Disk size for the sandbox in MiB SandboxMetadata: additionalProperties: type: string description: Metadata of the sandbox type: object SandboxState: type: string description: State of the sandbox enum: - running - paused SandboxNetworkConfig: type: object properties: allowPublicTraffic: type: boolean default: true description: >- Specify if the sandbox URLs should be accessible only with authentication. allowOut: type: array description: >- List of allowed destinations for egress traffic. Each entry can be a CIDR block (e.g. "8.8.8.8/32"), a bare IP address (e.g. "8.8.8.8"), or a domain name (e.g. "example.com", "*.example.com"). Allowed entries always take precedence over denied entries. items: type: string denyOut: type: array description: >- List of denied CIDR blocks or IP addresses for egress traffic. Domain names are not supported for deny rules. items: type: string egressProxy: $ref: '#/components/schemas/SandboxEgressProxyConfig' maskRequestHost: type: string description: Specify host mask which will be used for all sandbox requests rules: type: object description: > Per-domain transform rules applied to matching egress HTTP/HTTPS requests. Keys are domains (e.g. "api.example.com", "example.com"). A domain listed here is not automatically allowed - use allowOut to permit the traffic. additionalProperties: type: array items: $ref: '#/components/schemas/SandboxNetworkRule' SandboxLifecycle: type: object description: Sandbox lifecycle policy returned by sandbox info. required: - autoResume - onTimeout properties: autoResume: type: boolean description: Whether the sandbox can auto-resume. onTimeout: $ref: '#/components/schemas/SandboxOnTimeout' SandboxVolumeMount: type: object properties: name: type: string description: Name of the volume path: type: string description: Path of the volume required: - name - path Error: required: - code - message properties: code: type: integer format: int32 description: Error code message: type: string description: Error type: object SandboxEgressProxyConfig: type: object nullable: true description: >- SOCKS5 proxy for sandbox egress. Outbound TCP is tunneled through the proxy after allow/deny filtering; the sandbox is unaware. Domain-matched flows use remote DNS (ATYP=domain). required: - address properties: address: type: string description: >- SOCKS5 proxy address in host:port format (e.g. "proxy.example.com:1080"). username: type: string maxLength: 255 description: Optional SOCKS5 username (RFC 1929), max 255 bytes. password: type: string maxLength: 255 description: Optional SOCKS5 password (RFC 1929), max 255 bytes. SandboxNetworkRule: type: object description: Transform rule applied to egress requests matching a domain pattern. properties: transform: $ref: '#/components/schemas/SandboxNetworkTransform' SandboxOnTimeout: type: string description: Action taken when the sandbox times out. enum: - kill - pause SandboxNetworkTransform: type: object description: Transformations applied to matching egress requests before forwarding. properties: headers: type: object description: > HTTP headers to inject or override in matching requests. An existing header with the same name is replaced. Values are plain strings; secret resolution happens client-side before sending to the API. additionalProperties: type: string responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key ````