Class TunnelGroupBackends

A Tunnel Group Backend balances traffic among all online tunnels that match a label selector.

Hierarchy

TunnelGroupBackends

Index

Constructors

constructor

Methods

Constructors

constructor

new TunnelGroupBackends(httpClient: Wretcher): TunnelGroupBackends

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

Parameters
- httpClient: Wretcher
Returns TunnelGroupBackends

Methods

create

create(arg: TunnelGroupBackendCreate): Promise<TunnelGroupBackend>

- Defined in services.ts:724
Create a new TunnelGroup backend

Parameters
- arg: TunnelGroupBackendCreate
Returns Promise<TunnelGroupBackend>

delete

delete(id: any): Promise<void>

- Defined in services.ts:736
Delete a TunnelGroup backend by ID.

Parameters
- id: any
Returns Promise<void>

get

get(id: any): Promise<TunnelGroupBackend>

- Defined in services.ts:746
Get detailed information about a TunnelGroup backend by ID

Parameters
- id: any
Returns Promise<TunnelGroupBackend>

list

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

- Defined in services.ts:756
List all TunnelGroup backends on this account

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

update

update(arg: TunnelGroupBackendUpdate): Promise<TunnelGroupBackend>

- Defined in services.ts:806
Update TunnelGroup backend by ID

Parameters
- arg: TunnelGroupBackendUpdate
Returns Promise<TunnelGroupBackend>

Generated using TypeDoc