Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EdgesHTTPS

Hierarchy

  • EdgesHTTPS

Index

Constructors

Methods

Constructors

constructor

  • new EdgesHTTPS(httpClient: Wretcher): EdgesHTTPS

  • Do not construct this object directly, use the edgesHttps property of an Ngrok client object instead.

    Parameters

    • httpClient: Wretcher

    Returns EdgesHTTPS

Methods

create

delete

  • delete(id: any): Promise<void>

  • Delete an HTTPS Edge by ID

    Parameters

    • id: any

    Returns Promise<void>

get

list

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

  • Returns a list of all HTTPS Edges on this account

    Parameters

    • Optional beforeId: string
    • Optional limit: string

    Returns Promise<HTTPSEdge[]>

update

  • Updates an HTTPS 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

    Returns Promise<HTTPSEdge>

Generated using TypeDoc