class IpRestrictions extends AnyRef
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.
- Alphabetic
- By Inheritance
- IpRestrictions
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from IpRestrictions toany2stringadd[IpRestrictions] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (IpRestrictions, B)
- Implicit
- This member is added by an implicit conversion from IpRestrictions toArrowAssoc[IpRestrictions] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def create(type: String, ipPolicyIds: List[String], description: Option[String] = None, metadata: Option[String] = None, enforced: Option[Boolean] = None): Future[IpRestriction]
Create a new IP restriction
Create a new IP restriction
See also https://ngrok.com/docs/api#api-ip-restrictions-create.
- ipPolicyIds
the set of IP policy identifiers that are used to enforce the restriction
- description
human-readable description of this IP restriction. optional, max 255 bytes.
- metadata
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
- enforced
true if the IP restriction will be enforced. if false, only warnings will be issued
- returns
a scala.concurrent.Future encapsulating the API call's result
- def delete(id: String): Future[Unit]
Delete an IP restriction
Delete an IP restriction
See also https://ngrok.com/docs/api#api-ip-restrictions-delete.
- id
a resource identifier
- returns
a scala.concurrent.Future encapsulating the API call's result
- def ensuring(cond: (IpRestrictions) => Boolean, msg: => Any): IpRestrictions
- Implicit
- This member is added by an implicit conversion from IpRestrictions toEnsuring[IpRestrictions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (IpRestrictions) => Boolean): IpRestrictions
- Implicit
- This member is added by an implicit conversion from IpRestrictions toEnsuring[IpRestrictions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): IpRestrictions
- Implicit
- This member is added by an implicit conversion from IpRestrictions toEnsuring[IpRestrictions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): IpRestrictions
- Implicit
- This member is added by an implicit conversion from IpRestrictions toEnsuring[IpRestrictions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def get(id: String): Future[IpRestriction]
Get detailed information about an IP restriction
Get detailed information about an IP restriction
See also https://ngrok.com/docs/api#api-ip-restrictions-get.
- id
a resource identifier
- returns
a scala.concurrent.Future encapsulating the API call's result
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def list(beforeId: Option[String] = None, limit: Option[String] = None): Future[Page[IpRestrictionList]]
List all IP restrictions on this account
List all IP restrictions on this account
See also https://ngrok.com/docs/api#api-ip-restrictions-list.
- beforeId
the value of the
before_idparameter as a scala.Predef.String- limit
the value of the
limitparameter as a scala.Predef.String- returns
a scala.concurrent.Future encapsulating the API call's result
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def update(id: String, description: Option[String] = None, metadata: Option[String] = None, enforced: Option[Boolean] = None, ipPolicyIds: List[String] = List.empty): Future[IpRestriction]
Update attributes of an IP restriction by ID
Update attributes of an IP restriction by ID
See also https://ngrok.com/docs/api#api-ip-restrictions-update.
- id
the value of the
idparameter as a scala.Predef.String- description
human-readable description of this IP restriction. optional, max 255 bytes.
- metadata
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
- enforced
true if the IP restriction will be enforced. if false, only warnings will be issued
- ipPolicyIds
the set of IP policy identifiers that are used to enforce the restriction
- returns
a scala.concurrent.Future encapsulating the API call's result
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from IpRestrictions toStringFormat[IpRestrictions] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (IpRestrictions, B)
- Implicit
- This member is added by an implicit conversion from IpRestrictions toArrowAssoc[IpRestrictions] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.