Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IPRestrictions

An IP restriction is a restriction placed on the CIDRs that are allowed to initiate 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(id: any): Promise<void>

  • Delete an IP restriction

    Parameters

    • id: any

    Returns Promise<void>

get

list

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

  • List all IP restrictions on this account

    Parameters

    • Optional beforeId: string
    • Optional limit: string

    Returns Promise<IPRestriction[]>

update

Generated using TypeDoc