> ## Documentation Index > Fetch the complete documentation index at: https://docs.e2b.dev/llms.txt > Use this file to discover all available pages before exploring further. # Fork sandbox > Fork the sandbox: checkpoint the running sandbox in place (it is briefly paused, snapshotted with its full memory state, and resumed on its node, keeping its ID and expiration untouched) and create count new sandboxes from that snapshot. Returns one result per requested fork, each carrying either the created sandbox or the error that prevented it from starting. A non-201 status means the request failed before any fork was attempted. ## OpenAPI ````yaml /openapi-public.yaml post /sandboxes/{sandboxID}/fork 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 - name: Secrets - name: Events - name: Webhooks paths: /sandboxes/{sandboxID}/fork: servers: - url: https://api.e2b.app description: E2B Platform API post: tags: - Sandboxes summary: Fork sandbox description: >- Fork the sandbox: checkpoint the running sandbox in place (it is briefly paused, snapshotted with its full memory state, and resumed on its node, keeping its ID and expiration untouched) and create count new sandboxes from that snapshot. Returns one result per requested fork, each carrying either the created sandbox or the error that prevented it from starting. A non-201 status means the request failed before any fork was attempted. operationId: postSandboxFork parameters: - $ref: '#/components/parameters/sandboxID' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/SandboxForkRequest' responses: '201': description: >- The sandbox was snapshotted and the forks were attempted; each entry reports one fork's outcome content: application/json: schema: type: array items: $ref: '#/components/schemas/SandboxForkResult' '400': description: Bad request content: application/json: schema: required: - code - message properties: code: type: integer format: int32 description: Error code example: 400 error_code: type: string description: >- Machine-readable semantic error code. Not a closed set; initial values: sandbox_capacity_unavailable, sandbox_placement_timeout, sandbox_no_compatible_node, sandbox_create_failed, internal_server_error. message: type: string description: Error type: object examples: invalidSandboxId: summary: The sandbox ID is malformed value: code: 400 message: Invalid sandbox ID '401': description: Authentication error content: application/json: schema: required: - code - message properties: code: type: integer format: int32 description: Error code example: 401 error_code: type: string description: >- Machine-readable semantic error code. Not a closed set; initial values: sandbox_capacity_unavailable, sandbox_placement_timeout, sandbox_no_compatible_node, sandbox_create_failed, internal_server_error. message: type: string description: Error type: object examples: missingAuthentication: summary: No supported authentication header was supplied value: code: 401 message: authorization header is missing '403': description: Forbidden content: application/json: schema: required: - code - message properties: code: type: integer format: int32 description: Error code example: 403 error_code: type: string description: >- Machine-readable semantic error code. Not a closed set; initial values: sandbox_capacity_unavailable, sandbox_placement_timeout, sandbox_no_compatible_node, sandbox_create_failed, internal_server_error. message: type: string description: Error type: object examples: teamBanned: summary: The team is banned at authentication value: code: 403 message: team is banned teamBlocked: summary: >- The authenticated team is blocked. The message may append a reason value: code: 403 message: team is blocked '404': description: Not found content: application/json: schema: required: - code - message properties: code: type: integer format: int32 description: Error code example: 404 error_code: type: string description: >- Machine-readable semantic error code. Not a closed set; initial values: sandbox_capacity_unavailable, sandbox_placement_timeout, sandbox_no_compatible_node, sandbox_create_failed, internal_server_error. message: type: string description: Error type: object examples: sandboxNotFound: summary: No accessible sandbox or saved snapshot was found value: code: 404 message: >- Sandbox "sandboxid" doesn't exist or you don't have access to it '409': description: Conflict content: application/json: schema: required: - code - message properties: code: type: integer format: int32 description: Error code example: 409 error_code: type: string description: >- Machine-readable semantic error code. Not a closed set; initial values: sandbox_capacity_unavailable, sandbox_placement_timeout, sandbox_no_compatible_node, sandbox_create_failed, internal_server_error. message: type: string description: Error type: object examples: stateConflict: summary: The current sandbox state does not permit the operation value: code: 409 message: >- Sandbox 'sandboxid' cannot be forked while in 'pausing' state '429': description: Too many requests headers: Retry-After: description: >- When present, the number of seconds to wait before retrying the request. required: false schema: type: integer minimum: 0 example: 30 RateLimit-Limit: description: Configured rate-limit burst size. schema: type: integer RateLimit-Remaining: description: Requests remaining in the rate-limit window. schema: type: integer RateLimit-Reset: description: Seconds until the rate-limit window resets. schema: type: integer content: application/json: schema: required: - code - message properties: code: type: integer format: int32 description: Error code example: 429 error_code: type: string description: >- Machine-readable semantic error code. Not a closed set; initial values: sandbox_capacity_unavailable, sandbox_placement_timeout, sandbox_no_compatible_node, sandbox_create_failed, internal_server_error. message: type: string description: Error type: object examples: rateLimitExceeded: summary: A configured API rate limit was exceeded value: code: 429 message: Rate limit exceeded '500': description: Server error content: application/json: schema: required: - code - message properties: code: type: integer format: int32 description: Error code example: 500 error_code: type: string description: >- Machine-readable semantic error code. Not a closed set; initial values: sandbox_capacity_unavailable, sandbox_placement_timeout, sandbox_no_compatible_node, sandbox_create_failed, internal_server_error. message: type: string description: Error type: object examples: operationFailed: summary: The fork checkpoint fails value: code: 500 message: Error forking sandbox '503': description: Service unavailable content: application/json: schema: required: - code - message properties: code: type: integer format: int32 description: Error code example: 503 error_code: type: string description: >- Machine-readable semantic error code. Not a closed set; initial values: sandbox_capacity_unavailable, sandbox_placement_timeout, sandbox_no_compatible_node, sandbox_create_failed, internal_server_error. message: type: string description: Error type: object examples: nodeBusy: summary: The node cannot accept snapshot work value: code: 503 message: >- Sandbox 'sandboxid' cannot be forked right now because its node is busy, please retry security: - ApiKeyAuth: [] components: parameters: sandboxID: name: sandboxID in: path required: true schema: type: string schemas: SandboxForkRequest: type: object properties: timeout: type: integer format: int32 minimum: 0 default: 15 description: Time to live for the new forked sandboxes in seconds. count: type: integer format: int32 minimum: 1 maximum: 100 default: 1 description: >- Number of forked sandboxes to create. All forks boot from the same snapshot, so the snapshot is captured once regardless of count. Each fork succeeds or fails independently; the outcome of each is reported in its entry of the response list. SandboxForkResult: type: object description: >- Result of one requested fork. Exactly one of sandbox or error is set: sandbox when the fork started successfully, error when it failed to start. properties: sandbox: $ref: '#/components/schemas/Sandbox' error: $ref: '#/components/schemas/Error' Sandbox: required: - templateID - sandboxID - clientID - envdVersion properties: templateID: type: string description: Identifier of the template from which is the sandbox created sandboxID: type: string description: Identifier of the sandbox alias: type: string description: Alias of the template clientID: type: string deprecated: true description: Identifier of the client envdVersion: $ref: '#/components/schemas/EnvdVersion' envdAccessToken: type: string description: Access token used for envd communication trafficAccessToken: type: - string - 'null' description: Token required for accessing sandbox via proxy. domain: type: - string - 'null' description: Base domain where the sandbox traffic is accessible type: object Error: required: - code - message properties: code: type: integer format: int32 description: Error code error_code: type: string description: >- Machine-readable semantic error code. Not a closed set; initial values: sandbox_capacity_unavailable, sandbox_placement_timeout, sandbox_no_compatible_node, sandbox_create_failed, internal_server_error. message: type: string description: Error type: object EnvdVersion: type: string description: Version of the envd running in the sandbox securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key ````