Class Endpoints

Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned.

Hierarchy

Endpoints

Index

Constructors

constructor

Methods

Constructors

constructor

new Endpoints(httpClient: Wretcher): Endpoints

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

Parameters
- httpClient: Wretcher
Returns Endpoints

Methods

create

create(arg: EndpointCreate): Promise<Endpoint>

- Defined in services.ts:2467
Create an endpoint, currently available only for cloud endpoints

Parameters
- arg: EndpointCreate
Returns Promise<Endpoint>

delete

delete(id: any): Promise<void>

- Defined in services.ts:2545
Delete an Endpoint by ID, currently available only for cloud endpoints

Parameters
- id: any
Returns Promise<void>

get

get(id: any): Promise<Endpoint>

- Defined in services.ts:2525
Get the status of an endpoint by ID

Parameters
- id: any
Returns Promise<Endpoint>

list

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

- Defined in services.ts:2477
List all active endpoints on the account

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

update

update(arg: EndpointUpdate): Promise<Endpoint>

- Defined in services.ts:2535
Update an Endpoint by ID, currently available only for cloud endpoints

Parameters
- arg: EndpointUpdate
Returns Promise<Endpoint>

Generated using TypeDoc