Options
All
  • Public
  • Public/Protected
  • All
Menu

An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API requests, log in to the dashboard, start ngrok agents, and connect to your public-facing endpoints.

Hierarchy

  • IPRestrictions

Index

Constructors

Methods

Constructors

constructor

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

    Parameters

    • httpClient: Wretcher

    Returns IPRestrictions

Methods

create

delete

  • delete(arg: Item): Promise<void>
  • Delete an IP restriction

    Parameters

    Returns Promise<void>

get

  • Get detailed information about an IP restriction

    Parameters

    Returns Promise<IPRestriction>

list

  • List all IP restrictions on this account

    Returns Promise<IPRestriction[]>

update

Generated using TypeDoc