Class EdgesTLS

Hierarchy

EdgesTLS

Index

Constructors

constructor

Methods

Constructors

constructor

new EdgesTLS(httpClient: Wretcher): EdgesTLS

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

Parameters
- httpClient: Wretcher
Returns EdgesTLS

Methods

create

create(arg: TLSEdgeCreate): Promise<TLSEdge>

- Defined in services.ts:1901
Create a TLS Edge

Parameters
- arg: TLSEdgeCreate
Returns Promise<TLSEdge>

delete

delete(id: any): Promise<void>

- Defined in services.ts:1979
Delete a TLS Edge by ID

Parameters
- id: any
Returns Promise<void>

get

get(id: any): Promise<TLSEdge>

- Defined in services.ts:1911
Get a TLS Edge by ID

Parameters
- id: any
Returns Promise<TLSEdge>

list

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

- Defined in services.ts:1921
Returns a list of all TLS Edges on this account

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

update

update(arg: TLSEdgeUpdate): Promise<TLSEdge>

- Defined in services.ts:1969
Updates a TLS Edge 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: TLSEdgeUpdate
Returns Promise<TLSEdge>

Generated using TypeDoc