Class StaticBackends

A static backend sends traffic to a TCP address (hostname and port) that is reachable on the public internet.

Hierarchy

StaticBackends

Index

Constructors

constructor

Methods

Constructors

constructor

new StaticBackends(httpClient: Wretcher): StaticBackends

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

Parameters
- httpClient: Wretcher
Returns StaticBackends

Methods

create

create(arg: StaticBackendCreate): Promise<StaticBackend>

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

Parameters
- arg: StaticBackendCreate
Returns Promise<StaticBackend>

delete

delete(id: any): Promise<void>

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

Parameters
- id: any
Returns Promise<void>

get

get(id: any): Promise<StaticBackend>

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

Parameters
- id: any
Returns Promise<StaticBackend>

list

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

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

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

update

update(arg: StaticBackendUpdate): Promise<StaticBackend>

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

Parameters
- arg: StaticBackendUpdate
Returns Promise<StaticBackend>

Generated using TypeDoc