Tunnel

SDK reference for tunnel operations

Overview

Make HTTP requests through WebSocket tunnels to local services

• Category: internal
• Auth Required: No
• Supported Modes: standard, delegated, service

Operations

call

Make an HTTP request through a tunnel to a local service

Arguments:

• tunnel (string, optional): Tunnel name to use (defaults to 'default')
• method (string, optional): HTTP method (defaults to GET)
• path (string, required): Request path (e.g., /api/query)
• headers (object, optional): Request headers
• body (object, optional): Request body (for POST/PUT/PATCH)

Returns:

AdapterOperationResult - HTTP response with statusCode, headers, body, tunnelName, duration

Example:

const result = await mirra.tunnel.call({
  path: "example"
});

status

Check if a specific tunnel is connected

Arguments:

• tunnel (string, optional): Tunnel name to check (defaults to 'default')

Returns:

AdapterOperationResult - Tunnel status with connected, tunnelUrl, metadata

Example:

const result = await mirra.tunnel.status({});

list

List all connected tunnels for the user

Returns:

AdapterOperationResult - List of connected tunnels with names, URLs, and metadata

Example:

const result = await mirra.tunnel.list();