Class ReservedAddrs

Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.

Hierarchy

ReservedAddrs

Index

Constructors

constructor

Methods

Constructors

constructor

new ReservedAddrs(httpClient: Wretcher): ReservedAddrs

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

Parameters
- httpClient: Wretcher
Returns ReservedAddrs

Methods

create

create(arg: ReservedAddrCreate): Promise<ReservedAddr>

- Defined in services.ts:2795
Create a new reserved address.

Parameters
- arg: ReservedAddrCreate
Returns Promise<ReservedAddr>

delete

delete(id: any): Promise<void>

- Defined in services.ts:2807
Delete a reserved address.

Parameters
- id: any
Returns Promise<void>

get

get(id: any): Promise<ReservedAddr>

- Defined in services.ts:2817
Get the details of a reserved address.

Parameters
- id: any
Returns Promise<ReservedAddr>

list

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

- Defined in services.ts:2827
List all reserved addresses on this account.

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

update

update(arg: ReservedAddrUpdate): Promise<ReservedAddr>

- Defined in services.ts:2877
Update the attributes of a reserved address.

Parameters
- arg: ReservedAddrUpdate
Returns Promise<ReservedAddr>

Generated using TypeDoc