Exceptions - E2B Docs

SandboxException

class SandboxException(Exception)

Base class for all sandbox errors. Raised when a general sandbox exception occurs. Arguments:

status_code: HTTP status of the API response that produced this error, when there was one.

TimeoutException

class TimeoutException(SandboxException)

Raised when a timeout occurs. The unavailable exception type is caused by sandbox timeout. The canceled exception type is caused by exceeding request timeout. The deadline_exceeded exception type is caused by exceeding the timeout for process, watch, etc. The unknown exception type is sometimes caused by the sandbox timeout when the request is not processed correctly.

InvalidArgumentException

class InvalidArgumentException(SandboxException)

Raised when an invalid argument is provided.

NotEnoughSpaceException

class NotEnoughSpaceException(SandboxException)

Raised when there is not enough disk space.

NotFoundException

class NotFoundException(SandboxException)

Raised when a resource is not found. .. deprecated:: Use :class:FileNotFoundException or :class:SandboxNotFoundException instead. This class will be removed in the next major version.

FileNotFoundException

class FileNotFoundException(NotFoundException)

Raised when a file or directory is not found inside a sandbox.

SandboxNotFoundException

class SandboxNotFoundException(NotFoundException)

Raised when a sandbox is not found (e.g. it doesn’t exist or is no longer running).

AuthenticationException

class AuthenticationException(Exception)

Raised when authentication fails.

GitAuthException

class GitAuthException(AuthenticationException)

Raised when git authentication fails. :deprecated: Run git with sandbox.commands.run() instead. The git module will be removed in the next major version.

GitUpstreamException

class GitUpstreamException(SandboxException)

Raised when git upstream tracking is missing. :deprecated: Run git with sandbox.commands.run() instead. The git module will be removed in the next major version.

TemplateException

class TemplateException(SandboxException)

Exception raised when the template uses old envd version. It isn’t compatible with the new SDK.

RateLimitException

class RateLimitException(SandboxException)

Raised when the API rate limit is exceeded.

ServiceBusyException

class ServiceBusyException(Exception)

Raised when the API refused the operation because the service is temporarily busy (HTTP 503): no capacity to place a sandbox right now, or the node running the sandbox declined a request it cannot serve yet. Nothing was changed by the refused call: for example a refused pause leaves the sandbox running with its state intact, so the same call can be retried after a short wait. Like AuthenticationException and unlike the other API errors, this is not a SandboxException: it is raised for every 503 whatever the operation, so catch it explicitly. Arguments:

status_code: HTTP status of the API response: always 503.

BuildException

class BuildException(Exception)

Raised when the build fails.

FileUploadException

class FileUploadException(BuildException)

Raised when the file upload fails.

VolumeException

class VolumeException(Exception)

Base class for all volume errors. Raised when general volume errors occur.

VolumeNotFoundException

class VolumeNotFoundException(NotFoundException)

Raised when a volume is not found.

VolumePathNotFoundException

class VolumePathNotFoundException(NotFoundException)

Raised when a file or directory is not found inside a volume.

SecretException

class SecretException(Exception)

Base class for all secret errors. Raised when general secret errors occur.

SecretNotFoundException

class SecretNotFoundException(SecretException)

Raised when a secret is not found.

​SandboxException

​TimeoutException

​InvalidArgumentException

​NotEnoughSpaceException

​NotFoundException

​FileNotFoundException

​SandboxNotFoundException

​AuthenticationException

​GitAuthException

​GitUpstreamException

​TemplateException

​RateLimitException

​ServiceBusyException

​BuildException

​FileUploadException

​VolumeException

​VolumeNotFoundException

​VolumePathNotFoundException

​SecretException

​SecretNotFoundException