Class EdgesHTTPSRoutes

Hierarchy

EdgesHTTPSRoutes

Index

Constructors

constructor

Methods

Constructors

constructor

new EdgesHTTPSRoutes(httpClient: Wretcher): EdgesHTTPSRoutes

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

Parameters
- httpClient: Wretcher
Returns EdgesHTTPSRoutes

Methods

create

create(arg: HTTPSEdgeRouteCreate): Promise<HTTPSEdgeRoute>

- Defined in services.ts:1358
Create an HTTPS Edge Route

Parameters
- arg: HTTPSEdgeRouteCreate
Returns Promise<HTTPSEdgeRoute>

delete

delete(arg: EdgeRouteItem): Promise<void>

- Defined in services.ts:1392
Delete an HTTPS Edge Route by ID

Parameters
- arg: EdgeRouteItem
Returns Promise<void>

get

get(arg: EdgeRouteItem): Promise<HTTPSEdgeRoute>

- Defined in services.ts:1370
Get an HTTPS Edge Route by ID

Parameters
- arg: EdgeRouteItem
Returns Promise<HTTPSEdgeRoute>

update

update(arg: HTTPSEdgeRouteUpdate): Promise<HTTPSEdgeRoute>

- Defined in services.ts:1380
Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.

Parameters
- arg: HTTPSEdgeRouteUpdate
Returns Promise<HTTPSEdgeRoute>

Generated using TypeDoc