Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EndpointConfigurations

Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled. Endpoint configurations are only applied to Domains and TCP Addresses they have been attached to.

Hierarchy

  • EndpointConfigurations

Index

Constructors

Methods

Constructors

constructor

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

    Parameters

    • httpClient: Wretcher

    Returns EndpointConfigurations

Methods

create

delete

  • delete(arg: Item): Promise<void>
  • Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.

    Parameters

    Returns Promise<void>

get

  • Returns detailed information about an endpoint configuration

    Parameters

    Returns Promise<EndpointConfiguration>

list

  • Returns a list of all endpoint configurations on this account

    Returns Promise<EndpointConfiguration[]>

update

  • Updates an endpoint configuration. 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<EndpointConfiguration>

Generated using TypeDoc