Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Methods

Constructors

constructor

  • new Endpoints(httpClient: Wretcher): Endpoints
  • Do not construct this object directly, use the endpoints property of an Ngrok client object instead.

    Parameters

    • httpClient: Wretcher

    Returns Endpoints

Methods

get

list

  • list(beforeId?: string, limit?: string): Promise<Endpoint[]>
  • List all active endpoints on the account

    Parameters

    • Optional beforeId: string
    • Optional limit: string

    Returns Promise<Endpoint[]>

Generated using TypeDoc