Options
All
  • Public
  • Public/Protected
  • All
Menu

IP Policies are reusable groups of CIDR ranges with an allow or deny action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard.

Hierarchy

  • IPPolicies

Index

Constructors

Methods

Constructors

constructor

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

    Parameters

    • httpClient: Wretcher

    Returns IPPolicies

Methods

create

  • Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.

    Parameters

    Returns Promise<IPPolicy>

delete

  • delete(arg: Item): Promise<void>
  • Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.

    Parameters

    Returns Promise<void>

get

  • Get detailed information about an IP policy by ID.

    Parameters

    Returns Promise<IPPolicy>

list

  • List all IP policies on this account

    Returns Promise<IPPolicy[]>

update

  • Update attributes of an IP policy by ID

    Parameters

    Returns Promise<IPPolicy>

Generated using TypeDoc