class ApiKeys extends AnyRef

API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API. You may use the API itself to provision and manage API Keys but you'll need to provision your first API key from the API Keys page on your ngrok.com dashboard.

See also https://ngrok.com/docs/api#api-api-keys.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ApiKeys
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ApiKeys toany2stringadd[ApiKeys] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ApiKeys, B)
    Implicit
    This member is added by an implicit conversion from ApiKeys toArrowAssoc[ApiKeys] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def create(description: Option[String] = None, metadata: Option[String] = None): Future[ApiKey]

    Create a new API key.

    Create a new API key. The generated API key can be used to authenticate to the ngrok API.

    See also https://ngrok.com/docs/api#api-api-keys-create.

    description

    human-readable description of what uses the API key to authenticate. optional, max 255 bytes.

    metadata

    arbitrary user-defined data of this API key. optional, max 4096 bytes

    returns

    a scala.concurrent.Future encapsulating the API call's result

  9. def delete(id: String): Future[Unit]

    Delete an API key by ID

    Delete an API key by ID

    See also https://ngrok.com/docs/api#api-api-keys-delete.

    id

    a resource identifier

    returns

    a scala.concurrent.Future encapsulating the API call's result

  10. def ensuring(cond: (ApiKeys) => Boolean, msg: => Any): ApiKeys
    Implicit
    This member is added by an implicit conversion from ApiKeys toEnsuring[ApiKeys] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (ApiKeys) => Boolean): ApiKeys
    Implicit
    This member is added by an implicit conversion from ApiKeys toEnsuring[ApiKeys] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): ApiKeys
    Implicit
    This member is added by an implicit conversion from ApiKeys toEnsuring[ApiKeys] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): ApiKeys
    Implicit
    This member is added by an implicit conversion from ApiKeys toEnsuring[ApiKeys] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. def get(id: String): Future[ApiKey]

    Get the details of an API key by ID.

    Get the details of an API key by ID.

    See also https://ngrok.com/docs/api#api-api-keys-get.

    id

    a resource identifier

    returns

    a scala.concurrent.Future encapsulating the API call's result

  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def list(beforeId: Option[String] = None, limit: Option[String] = None): Future[Page[ApiKeyList]]

    List all API keys owned by this account

    List all API keys owned by this account

    See also https://ngrok.com/docs/api#api-api-keys-list.

    beforeId

    the value of the before_id parameter as a scala.Predef.String

    limit

    the value of the limit parameter as a scala.Predef.String

    returns

    a scala.concurrent.Future encapsulating the API call's result

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. def update(id: String, description: Option[String] = None, metadata: Option[String] = None): Future[ApiKey]

    Update attributes of an API key by ID.

    Update attributes of an API key by ID.

    See also https://ngrok.com/docs/api#api-api-keys-update.

    id

    the value of the id parameter as a scala.Predef.String

    description

    human-readable description of what uses the API key to authenticate. optional, max 255 bytes.

    metadata

    arbitrary user-defined data of this API key. optional, max 4096 bytes

    returns

    a scala.concurrent.Future encapsulating the API call's result

  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ApiKeys toStringFormat[ApiKeys] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (ApiKeys, B)
    Implicit
    This member is added by an implicit conversion from ApiKeys toArrowAssoc[ApiKeys] 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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromApiKeys to any2stringadd[ApiKeys]

Inherited by implicit conversion StringFormat fromApiKeys to StringFormat[ApiKeys]

Inherited by implicit conversion Ensuring fromApiKeys to Ensuring[ApiKeys]

Inherited by implicit conversion ArrowAssoc fromApiKeys to ArrowAssoc[ApiKeys]

Ungrouped