Manage E2B team identity, API keys, and CLI access tokens. API keys authenticate SDK and REST traffic via the X-API-Key header. Access tokens authenticate the e2b CLI and CI workflows. Team metrics expose aggregated sandbox usage counts for the workspace.
openapi: 3.0.0
info:
version: 0.1.0
title: E2B API
servers:
- url: https://api.e2b.app
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
AccessTokenAuth:
type: http
scheme: bearer
bearerFormat: access_token
# Generated code uses security schemas in the alphabetical order.
# In order to check first the token, and then the team (so we can already use the user),
# there is a 1 and 2 present in the names of the security schemas.
Supabase1TokenAuth:
type: apiKey
in: header
name: X-Supabase-Token
Supabase2TeamAuth:
type: apiKey
in: header
name: X-Supabase-Team
AdminTokenAuth:
type: apiKey
in: header
name: X-Admin-Token
parameters:
templateID:
name: templateID
in: path
required: true
schema:
type: string
buildID:
name: buildID
in: path
required: true
schema:
type: string
sandboxID:
name: sandboxID
in: path
required: true
schema:
type: string
teamID:
name: teamID
in: path
required: true
schema:
type: string
nodeID:
name: nodeID
in: path
required: true
schema:
type: string
apiKeyID:
name: apiKeyID
in: path
required: true
schema:
type: string
accessTokenID:
name: accessTokenID
in: path
required: true
schema:
type: string
snapshotID:
name: snapshotID
in: path
required: true
schema:
type: string
description: Identifier of the snapshot (template ID)
tag:
name: tag
in: path
required: true
schema:
type: string
description: Tag name
paginationLimit:
name: limit
in: query
description: Maximum number of items to return per page
required: false
schema:
type: integer
format: int32
minimum: 1
default: 100
maximum: 100
paginationNextToken:
name: nextToken
in: query
description: Cursor to start the list from
required: false
schema:
type: string
volumeID:
name: volumeID
in: path
required: true
schema:
type: string
responses:
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Team:
required:
- teamID
- name
- apiKey
- isDefault
properties:
teamID:
type: string
description: Identifier of the team
name:
type: string
description: Name of the team
apiKey:
type: string
description: API key for the team
isDefault:
type: boolean
description: Whether the team is the default team
TeamUser:
required:
- id
- email
properties:
id:
type: string
format: uuid
description: Identifier of the user
email:
type: string
description: Email of the user
TemplateUpdateRequest:
properties:
public:
type: boolean
description: Whether the template is public or only accessible by the team
TemplateUpdateResponse:
required:
- names
properties:
names:
type: array
description: Names of the template (namespace/alias format when namespaced)
items:
type: string
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
EnvdVersion:
type: string
description: Version of the envd running in the sandbox
SandboxMetadata:
additionalProperties:
type: string
description: Metadata of the sandbox
SandboxState:
type: string
description: State of the sandbox
enum:
- running
- paused
SnapshotInfo:
type: object
required:
- snapshotID
- names
properties:
snapshotID:
type: string
description: Identifier of the snapshot template including the tag. Uses namespace/alias when a name was provided (e.g. team-slug/my-snapshot:default), otherwise falls back to the raw template ID (e.g. abc123:default).
names:
type: array
items:
type: string
description: Full names of the snapshot template including team namespace and tag (e.g. team-slug/my-snapshot:v2)
EnvVars:
additionalProperties:
type: string
description: Environment variables for the sandbox
Mcp:
type: object
description: MCP configuration for the sandbox
additionalProperties: {}
nullable: true
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 CIDR blocks or IP addresses for egress traffic. Allowed addresses always take precedence over blocked addresses.
items:
type: string
denyOut:
type: array
description: List of denied CIDR blocks or IP addresses for egress traffic
items:
type: string
maskRequestHost:
type: string
description: Specify host mask which will be used for all sandbox requests
SandboxAutoResumeEnabled:
type: boolean
description: Auto-resume enabled flag for paused sandboxes. Default false.
default: false
SandboxAutoResumeConfig:
type: object
description: Auto-resume configuration for paused sandboxes.
required:
- enabled
properties:
enabled:
$ref: "#/components/schemas/SandboxAutoResumeEnabled"
SandboxOnTimeout:
type: string
description: Action taken when the sandbox times out.
enum:
- kill
- pause
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"
SandboxLog:
description: Log entry with timestamp and line
required:
- timestamp
- line
properties:
timestamp:
type: string
format: date-time
description: Timestamp of the log entry
line:
type: string
description: Log line content
SandboxLogEntry:
required:
- timestamp
- level
- message
- fields
properties:
timestamp:
type: string
format: date-time
description: Timestamp of the log entry
message:
type: string
description: Log message content
level:
$ref: '#/components/schemas/LogLevel'
fields:
type: object
additionalProperties:
type: string
SandboxLogs:
required:
- logs
- logEntries
properties:
logs:
description: Logs of the sandbox
type: array
items:
$ref: '#/components/schemas/SandboxLog'
logEntries:
description: Structured logs of the sandbox
type: array
items:
$ref: '#/components/schemas/SandboxLogEntry'
SandboxLogsV2Response:
required:
- logs
properties:
logs:
default: []
description: Sandbox logs structured
type: array
items:
$ref: '#/components/schemas/SandboxLogEntry'
SandboxMetric:
description: Metric entry with timestamp and line
required:
- timestamp
- timestampUnix
- cpuCount
- cpuUsedPct
- memUsed
- memTotal
- diskUsed
- diskTotal
properties:
timestamp:
type: string
format: date-time
deprecated: true
description: Timestamp of the metric entry
timestampUnix:
type: integer
format: int64
description: Timestamp of the metric entry in Unix time (seconds since epoch)
cpuCount:
type: integer
format: int32
description: Number of CPU cores
cpuUsedPct:
type: number
format: float
description: CPU usage percentage
memUsed:
type: integer
format: int64
description: Memory used in bytes
memTotal:
type: integer
format: int64
description: Total memory in bytes
diskUsed:
type: integer
format: int64
description: Disk used in bytes
diskTotal:
type: integer
format: int64
description: Total disk space in bytes
SandboxVolumeMount:
type: object
properties:
name:
type: string
description: Name of the volume
path:
type: string
description: Path of the volume
required:
- name
- path
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
nullable: true
description: Token required for accessing sandbox via proxy.
domain:
type: string
nullable: true
description: Base domain where the sandbox traffic is accessible
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
description: Access token used for envd communication
allowInternetAccess:
type: boolean
nullable: true
description: Whether internet access was explicitly enabled or disabled for the sandbox. Null means it was not explicitly set.
domain:
type: string
nullable: true
description: Base domain where the sandbox traffic is accessible
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'
ListedSandbox:
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
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'
envdVersion:
$ref: '#/components/schemas/EnvdVersion'
volumeMounts:
type: array
items:
$ref: '#/components/schemas/SandboxVolumeMount'
SandboxesWithMetrics:
required:
- sandboxes
properties:
sandboxes:
additionalProperties:
$ref: '#/components/schemas/SandboxMetric'
NewSandbox:
required:
- templateID
properties:
templateID:
type: string
description: Identifier of the required template
timeout:
type: integer
format: int32
minimum: 0
default: 15
description: Time to live for the sandbox in seconds.
autoPause:
type: boolean
default: false
description: Automatically pauses the sandbox after the timeout
autoResume:
$ref: '#/components/schemas/SandboxAutoResumeConfig'
secure:
type: boolean
description: Secure all system communication with sandbox
allow_internet_access:
type: boolean
description:
Allow sandbox to access the internet. When set to false, it behaves the same as specifying denyOut
to 0.0.0.0/0 in the network config.
network:
$ref: '#/components/schemas/SandboxNetworkConfig'
metadata:
$ref: '#/components/schemas/SandboxMetadata'
envVars:
$ref: '#/components/schemas/EnvVars'
mcp:
$ref: '#/components/schemas/Mcp'
volumeMounts:
type: array
items:
$ref: '#/components/schemas/SandboxVolumeMount'
ResumedSandbox:
properties:
timeout:
type: integer
format: int32
minimum: 0
default: 15
description: Time to live for the sandbox in seconds.
autoPause:
type: boolean
deprecated: true
description: Automatically pauses the sandbox after the timeout
ConnectSandbox:
type: object
required:
- timeout
properties:
timeout:
description: Timeout in seconds from the current time after which the sandbox should expire
type: integer
format: int32
minimum: 0
TeamMetric:
description: Team metric with timestamp
required:
- timestamp
- timestampUnix
- concurrentSandboxes
- sandboxStartRate
properties:
timestamp:
type: string
format: date-time
deprecated: true
description: Timestamp of the metric entry
timestampUnix:
type: integer
format: int64
description: Timestamp of the metric entry in Unix time (seconds since epoch)
concurrentSandboxes:
type: integer
format: int32
description: The number of concurrent sandboxes for the team
sandboxStartRate:
type: number
format: float
description: Number of sandboxes started per second
MaxTeamMetric:
description: Team metric with timestamp
required:
- timestamp
- timestampUnix
- value
properties:
timestamp:
type: string
format: date-time
deprecated: true
description: Timestamp of the metric entry
timestampUnix:
type: integer
format: int64
description: Timestamp of the metric entry in Unix time (seconds since epoch)
value:
type: number
description: The maximum value of the requested metric in the given interval
AdminSandboxKillResult:
required:
- killedCount
- failedCount
properties:
killedCount:
type: integer
description: Number of sandboxes successfully killed
failedCount:
type: integer
description: Number of sandboxes that failed to kill
AdminBuildCancelResult:
required:
- cancelledCount
- failedCount
properties:
cancelledCount:
type: integer
description: Number of builds successfully cancelled
failedCount:
type: integer
description: Number of builds that failed to cancel
VolumeToken:
type: object
properties:
token:
type: string
required:
- token
Template:
required:
- templateID
- buildID
- cpuCount
- memoryMB
- diskSizeMB
- public
- createdAt
- updatedAt
- createdBy
- lastSpawnedAt
- spawnCount
- buildCount
- envdVersion
- aliases
- names
- buildStatus
properties:
templateID:
type: string
description: Identifier of the template
buildID:
type: string
description: Identifier of the last successful build for given template
cpuCount:
$ref: '#/components/schemas/CPUCount'
memoryMB:
$ref: '#/components/schemas/MemoryMB'
diskSizeMB:
$ref: '#/components/schemas/DiskSizeMB'
public:
type: boolean
description: Whether the template is public or only accessible by the team
aliases:
type: array
description: Aliases of the template
deprecated: true
items:
type: string
names:
type: array
description: Names of the template (namespace/alias format when namespaced)
items:
type: string
createdAt:
type: string
format: date-time
description: Time when the template was created
updatedAt:
type: string
format: date-time
description: Time when the template was last updated
createdBy:
allOf:
- $ref: '#/components/schemas/TeamUser'
nullable: true
lastSpawnedAt:
type: string
nullable: true
format: date-time
description: Time when the template was last used
spawnCount:
type: integer
format: int64
description: Number of times the template was used
buildCount:
type: integer
format: int32
description: Number of times the template was built
envdVersion:
$ref: '#/components/schemas/EnvdVersion'
buildStatus:
$ref: '#/components/schemas/TemplateBuildStatus'
TemplateRequestResponseV3:
required:
- templateID
- buildID
- public
- aliases
- names
- tags
properties:
templateID:
type: string
description: Identifier of the template
buildID:
type: string
description: Identifier of the last successful build for given template
public:
type: boolean
description: Whether the template is public or only accessible by the team
names:
type: array
description: Names of the template
items:
type: string
tags:
type: array
description: Tags assigned to the template build
items:
type: string
aliases:
type: array
description: Aliases of the template
deprecated: true
items:
type: string
TemplateLegacy:
required:
- templateID
- buildID
- cpuCount
- memoryMB
- diskSizeMB
- public
- createdAt
- updatedAt
- createdBy
- lastSpawnedAt
- spawnCount
- buildCount
- envdVersion
- aliases
properties:
templateID:
type: string
description: Identifier of the template
buildID:
type: string
description: Identifier of the last successful build for given template
cpuCount:
$ref: '#/components/schemas/CPUCount'
memoryMB:
$ref: '#/components/schemas/MemoryMB'
diskSizeMB:
$ref: '#/components/schemas/DiskSizeMB'
public:
type: boolean
description: Whether the template is public or only accessible by the team
aliases:
type: array
description: Aliases of the template
items:
type: string
createdAt:
type: string
format: date-time
description: Time when the template was created
updatedAt:
type: string
format: date-time
description: Time when the template was last updated
createdBy:
allOf:
- $ref: '#/components/schemas/TeamUser'
nullable: true
lastSpawnedAt:
type: string
nullable: true
format: date-time
description: Time when the template was last used
spawnCount:
type: integer
format: int64
description: Number of times the template was used
buildCount:
type: integer
format: int32
description: Number of times the template was built
envdVersion:
$ref: '#/components/schemas/EnvdVersion'
TemplateBuild:
required:
- buildID
- status
- createdAt
- updatedAt
- cpuCount
- memoryMB
properties:
buildID:
type: string
format: uuid
description: Identifier of the build
status:
$ref: '#/components/schemas/TemplateBuildStatus'
createdAt:
type: string
format: date-time
description: Time when the build was created
updatedAt:
type: string
format: date-time
description: Time when the build was last updated
finishedAt:
type: string
format: date-time
description: Time when the build was finished
cpuCount:
$ref: '#/components/schemas/CPUCount'
memoryMB:
$ref: '#/components/schemas/MemoryMB'
diskSizeMB:
$ref: '#/components/schemas/DiskSizeMB'
envdVersion:
$ref: '#/components/schemas/EnvdVersion'
TemplateWithBuilds:
required:
- templateID
- public
- aliases
- names
- createdAt
- updatedAt
- lastSpawnedAt
- spawnCount
- builds
properties:
templateID:
type: string
description: Identifier of the template
public:
type: boolean
description: Whether the template is public or only accessible by the team
aliases:
type: array
description: Aliases of the template
deprecated: true
items:
type: string
names:
type: array
description: Names of the template (namespace/alias format when namespaced)
items:
type: string
createdAt:
type: string
format: date-time
description: Time when the template was created
updatedAt:
type: string
format: date-time
description: Time when the template was last updated
lastSpawnedAt:
type: string
nullable: true
format: date-time
description: Time when the template was last used
spawnCount:
type: integer
format: int64
description: Number of times the template was used
builds:
type: array
description: List of builds for the template
items:
$ref: '#/components/schemas/TemplateBuild'
TemplateAliasResponse:
required:
- templateID
- public
properties:
templateID:
type: string
description: Identifier of the template
public:
type: boolean
description: Whether the template is public or only accessible by the team
TemplateBuildRequest:
required:
- dockerfile
properties:
alias:
description: Alias of the template
type: string
dockerfile:
description: Dockerfile for the template
type: string
teamID:
type: string
description: Identifier of the team
startCmd:
description: Start command to execute in the template after the build
type: string
readyCmd:
description: Ready check command to execute in the template after the build
type: string
cpuCount:
$ref: '#/components/schemas/CPUCount'
memoryMB:
$ref: '#/components/schemas/MemoryMB'
TemplateStep:
description: Step in the template build process
required:
- type
properties:
type:
type: string
description: Type of the step
args:
default: []
type: array
description: Arguments for the step
items:
type: string
filesHash:
type: string
description: Hash of the files used in the step
force:
default: false
type: boolean
description: Whether the step should be forced to run regardless of the cache
TemplateBuildRequestV3:
properties:
name:
description: Name of the template. Can include a tag with colon separator (e.g. "my-template" or "my-template:v1"). If tag is included, it will be treated as if the tag was provided in the tags array.
type: string
tags:
type: array
description: Tags to assign to the template build
items:
type: string
alias:
description: Alias of the template. Deprecated, use name instead.
type: string
deprecated: true
teamID:
deprecated: true
type: string
description: Identifier of the team
cpuCount:
$ref: '#/components/schemas/CPUCount'
memoryMB:
$ref: '#/components/schemas/MemoryMB'
TemplateBuildRequestV2:
required:
- alias
properties:
alias:
description: Alias of the template
type: string
teamID:
deprecated: true
type: string
description: Identifier of the team
cpuCount:
$ref: '#/components/schemas/CPUCount'
memoryMB:
$ref: '#/components/schemas/MemoryMB'
FromImageRegistry:
oneOf:
- $ref: '#/components/schemas/AWSRegistry'
- $ref: '#/components/schemas/GCPRegistry'
- $ref: '#/components/schemas/GeneralRegistry'
discriminator:
propertyName: type
mapping:
aws: '#/components/schemas/AWSRegistry'
gcp: '#/components/schemas/GCPRegistry'
registry: '#/components/schemas/GeneralRegistry'
AWSRegistry:
type: object
required:
- type
- awsAccessKeyId
- awsSecretAccessKey
- awsRegion
properties:
type:
type: string
enum: [aws]
description: Type of registry authentication
awsAccessKeyId:
type: string
description: AWS Access Key ID for ECR authentication
awsSecretAccessKey:
type: string
description: AWS Secret Access Key for ECR authentication
awsRegion:
type: string
description: AWS Region where the ECR registry is located
GCPRegistry:
type: object
required:
- type
- serviceAccountJson
properties:
type:
type: string
enum: [gcp]
description: Type of registry authentication
serviceAccountJson:
type: string
description: Service Account JSON for GCP authentication
GeneralRegistry:
type: object
required:
- type
- username
- password
properties:
type:
type: string
enum: [registry]
description: Type of registry authentication
username:
type: string
description: Username to use for the registry
password:
type: string
description: Password to use for the registry
TemplateBuildStartV2:
type: object
properties:
fromImage:
type: string
description: Image to use as a base for the template build
fromTemplate:
type: string
description: Template to use as a base for the template build
fromImageRegistry:
$ref: '#/components/schemas/FromImageRegistry'
force:
default: false
type: boolean
description: Whether the whole build should be forced to run regardless of the cache
steps:
default: []
description: List of steps to execute in the template build
type: array
items:
$ref: '#/components/schemas/TemplateStep'
startCmd:
description: Start command to execute in the template after the build
type: string
readyCmd:
description: Ready check command to execute in the template after the build
type: string
TemplateBuildFileUpload:
required:
- present
properties:
present:
type: boolean
description: Whether the
# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/e2b-dev/refs/heads/main/openapi/e2b-api-openapi.yml