class TlsCertificates extends AnyRef

TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.

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

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TlsCertificates
  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 TlsCertificates toany2stringadd[TlsCertificates] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TlsCertificates, B)
    Implicit
    This member is added by an implicit conversion from TlsCertificates toArrowAssoc[TlsCertificates] 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(certificatePem: String, privateKeyPem: String, description: Option[String] = None, metadata: Option[String] = None): Future[TlsCertificate]

    Upload a new TLS certificate

    Upload a new TLS certificate

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

    certificatePem

    chain of PEM-encoded certificates, leaf first. See Certificate Bundles.

    privateKeyPem

    private key for the TLS certificate, PEM-encoded. See Private Keys.

    description

    human-readable description of this TLS certificate. optional, max 255 bytes.

    metadata

    arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.

    returns

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

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

    Delete a TLS certificate

    Delete a TLS certificate

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

    id

    a resource identifier

    returns

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

  10. def ensuring(cond: (TlsCertificates) => Boolean, msg: => Any): TlsCertificates
    Implicit
    This member is added by an implicit conversion from TlsCertificates toEnsuring[TlsCertificates] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (TlsCertificates) => Boolean): TlsCertificates
    Implicit
    This member is added by an implicit conversion from TlsCertificates toEnsuring[TlsCertificates] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): TlsCertificates
    Implicit
    This member is added by an implicit conversion from TlsCertificates toEnsuring[TlsCertificates] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): TlsCertificates
    Implicit
    This member is added by an implicit conversion from TlsCertificates toEnsuring[TlsCertificates] 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[TlsCertificate]

    Get detailed information about a TLS certificate

    Get detailed information about a TLS certificate

    See also https://ngrok.com/docs/api#api-tls-certificates-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[TlsCertificateList]]

    List all TLS certificates on this account

    List all TLS certificates on this account

    See also https://ngrok.com/docs/api#api-tls-certificates-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[TlsCertificate]

    Update attributes of a TLS Certificate by ID

    Update attributes of a TLS Certificate by ID

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

    id

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

    description

    human-readable description of this TLS certificate. optional, max 255 bytes.

    metadata

    arbitrary user-defined machine-readable data of this TLS certificate. 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 TlsCertificates toStringFormat[TlsCertificates] 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): (TlsCertificates, B)
    Implicit
    This member is added by an implicit conversion from TlsCertificates toArrowAssoc[TlsCertificates] 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 fromTlsCertificates to any2stringadd[TlsCertificates]

Inherited by implicit conversion StringFormat fromTlsCertificates to StringFormat[TlsCertificates]

Inherited by implicit conversion Ensuring fromTlsCertificates to Ensuring[TlsCertificates]

Inherited by implicit conversion ArrowAssoc fromTlsCertificates to ArrowAssoc[TlsCertificates]

Ungrouped