Class Tunnels

Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.

Hierarchy

Tunnels

Index

Constructors

constructor

Methods

get
list

Constructors

constructor

new Tunnels(httpClient: Wretcher): Tunnels

- Defined in services.ts:3934
Do not construct this object directly, use the tunnels property of an Ngrok client object instead.

Parameters
- httpClient: Wretcher
Returns Tunnels

Methods

get

get(id: any): Promise<Tunnel>

- Defined in services.ts:3988
Get the status of a tunnel by ID

Parameters
- id: any
Returns Promise<Tunnel>

list

list(beforeId?: string, limit?: string): Promise<Tunnel[]>

- Defined in services.ts:3940
List all online tunnels currently running on the account.

Parameters
- Optional beforeId: string
- Optional limit: string
Returns Promise<Tunnel[]>

Generated using TypeDoc