SandboxesClient

Source: src/services/sandboxes.ts

Signature

SandboxesClient(transport: Leap0Transport)

Overview

Creates, fetches, pauses, and deletes sandboxes.

Throws

• Leap0Error: If request validation, API calls, or response validation fail.

Methods

create

async create(params: CreateSandboxParams = {}, options: RequestOptions = {}): Promise<T>

Creates a sandbox from a template and resource config.

Parameters

• params: Sandbox creation parameters.
• options: Optional request settings such as timeout and query params.

Returns

• The created sandbox resource.

Throws

• Leap0Error: If params are invalid, local OTEL env is missing, or sandbox creation fails.

Examples

const sandbox = await client.sandboxes.create({
  templateName: "base",
  timeoutMin: 30,
});

pause

async pause(sandbox: SandboxRef, options: RequestOptions = {}): Promise<T>

Pauses a running sandbox.

Parameters

• sandbox: Sandbox ID or sandbox-like object.
• options: Optional request settings such as timeout and query params.

Returns

• The updated sandbox resource.

get

async get(sandbox: SandboxRef, options: RequestOptions = {}): Promise<T>

Fetches a sandbox by ID.

Parameters

• sandbox: Sandbox ID or sandbox-like object.
• options: Optional request settings such as timeout and query params.

Returns

• The current sandbox resource.

delete

async delete(sandbox: SandboxRef, options: RequestOptions = {}): Promise<void>

Deletes a sandbox by ID.

Parameters

• sandbox: Sandbox ID or sandbox-like object.
• options: Optional request settings such as timeout and query params.

invokeUrl

invokeUrl(sandbox: SandboxRef, path = "/", port?: number): string

Builds the public invoke URL for a sandbox.

Parameters

• sandbox: Sandbox ID or sandbox-like object.
• path: Route path to append to the sandbox base URL.
• port: Optional forwarded port.

Returns

• The public HTTPS URL for the sandbox.

websocketUrl

websocketUrl(sandbox: SandboxRef, path = "/", port?: number): string

Builds the public websocket URL for a sandbox.

Parameters

• sandbox: Sandbox ID or sandbox-like object.
• path: Route path to append to the sandbox base URL.
• port: Optional forwarded port.

Returns

• The public websocket URL for the sandbox.