> ## 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. # List ## OpenAPI ````yaml /openapi-public.yaml post /process.Process/List 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: /process.Process/List: servers: - url: https://sandbox.e2b.app description: Sandbox API (envd) - routes using sandbox ID and port headers post: tags: - Process summary: List operationId: process.Process.List parameters: - name: E2b-Sandbox-Id in: header required: true description: >- Identifier of the target sandbox. Routes the request to that sandbox's envd over the shared sandbox host. schema: type: string - name: E2b-Sandbox-Port in: header required: true description: Port envd listens on inside the sandbox (default 49983). schema: type: integer default: 49983 example: 49983 - name: Connect-Protocol-Version in: header required: true schema: type: string enum: - '1' example: '1' - name: Connect-Timeout-Ms in: header schema: $ref: '#/components/schemas/connect-timeout-header' requestBody: content: application/json: schema: $ref: '#/components/schemas/process.ListRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/process.ListResponse' '400': description: >- The sandbox proxy rejects missing or invalid routing information. Connect RPC error: invalid_argument. content: text/plain: schema: type: string examples: missingRoutingHeader: summary: >- The sandbox proxy rejects missing or invalid routing information. value: | missing header application/json: schema: $ref: '#/components/schemas/ConnectRPCError' examples: invalid_argument: summary: Example invalid_argument response value: code: invalid_argument message: 'Connect-Protocol-Version must be "1": got "invalid"' '401': description: >- Sandbox access-token or signature authentication failed. Connect RPC error: unauthenticated. content: application/json: schema: anyOf: - $ref: '#/components/schemas/EnvdHTTPError' - $ref: '#/components/schemas/ConnectRPCError' examples: sandboxAuthentication: summary: Missing or invalid sandbox credentials value: code: 401 message: >- unauthorized access, please provide a valid access token or method signing if supported unauthenticated: summary: Example unauthenticated response value: code: unauthenticated message: 'invalid username: ''nonexistent''' '500': description: The sandbox proxy encountered an unexpected routing error. content: text/plain: schema: type: string examples: routingFailure: summary: The sandbox proxy encountered an unexpected routing error. value: | Unexpected error when routing request: invalid sandbox port '502': description: >- The sandbox proxy could not find the sandbox. Browser navigation may receive an HTML error page. content: application/json: schema: $ref: '#/components/schemas/SandboxRoutingError' examples: sandboxNotFound: value: sandboxId: sandbox-id message: The sandbox was not found code: 502 text/html: schema: type: string default: description: Error content: application/json: schema: $ref: '#/components/schemas/connect.error' security: - SandboxAccessTokenAuth: [] components: schemas: connect-timeout-header: type: number title: Connect-Timeout-Ms description: Define the timeout, in ms process.ListRequest: type: object title: ListRequest additionalProperties: false process.ListResponse: type: object properties: processes: type: array items: $ref: '#/components/schemas/process.ProcessInfo' title: processes title: ListResponse additionalProperties: false ConnectRPCError: type: object required: - code properties: code: type: string description: Connect error code, such as not_found or invalid_argument. message: type: string details: type: array items: type: object properties: type: type: string value: type: string format: byte debug: {} description: >- Connect JSON error. The code is a string, unlike envd's numeric HTTP errors. EnvdHTTPError: type: object required: - code - message properties: code: type: integer message: type: string description: >- HTTP error from envd, with a numeric status code. Distinct from a Connect RPC error. SandboxRoutingError: type: object required: - sandboxId - message - code properties: sandboxId: type: string message: type: string code: type: integer connect.error: type: object properties: code: type: string examples: - not_found enum: - canceled - unknown - invalid_argument - deadline_exceeded - not_found - already_exists - permission_denied - resource_exhausted - failed_precondition - aborted - out_of_range - unimplemented - internal - unavailable - data_loss - unauthenticated description: >- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. message: type: string description: >- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. details: type: array items: $ref: '#/components/schemas/connect.error_details.Any' description: >- A list of messages that carry the error details. There is no limit on the number of messages. title: Connect Error additionalProperties: true description: >- Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation process.ProcessInfo: type: object properties: config: $ref: '#/components/schemas/process.ProcessConfig' title: config pid: type: integer title: pid tag: type: - string - 'null' title: tag title: ProcessInfo additionalProperties: false connect.error_details.Any: type: object properties: type: type: string description: >- A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. This is used to determine the schema of the data in the `value` field and is the discriminator for the `debug` field. value: type: string format: binary description: >- The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field. debug: oneOf: - type: object title: Any additionalProperties: true description: Detailed error information. discriminator: propertyName: type title: Debug description: >- Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic. additionalProperties: true description: >- Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details. process.ProcessConfig: type: object properties: cmd: type: string title: cmd args: type: array items: type: string title: args envs: type: object title: envs additionalProperties: type: string title: value cwd: type: - string - 'null' title: cwd title: ProcessConfig additionalProperties: false securitySchemes: SandboxAccessTokenAuth: type: apiKey in: header name: X-Access-Token description: >- Sandbox access token (`envdAccessToken`) for authenticating requests to a running sandbox. Returned by: [POST /sandboxes](/api-reference/sandboxes/create-sandbox) (on create), [POST /sandboxes/{sandboxID}/connect](/api-reference/sandboxes/connect-to-sandbox) (on connect), [POST /sandboxes/{sandboxID}/resume](/api-reference/sandboxes/resume-sandbox) (on resume), and [GET /sandboxes/{sandboxID}](/api-reference/sandboxes/get-sandbox) (for running or paused sandboxes). ````