Packages

class Ngrok extends AnyRef

Main entry point for the ngrok API.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Ngrok
  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

Type Members

  1. class BackendsNamespace extends AnyRef

    A namespace object for Backends.

  2. class EdgeModulesNamespace extends AnyRef

    A namespace object for EdgeModules.

  3. class EdgesNamespace extends AnyRef

    A namespace object for Edges.

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 Ngrok toany2stringadd[Ngrok] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Ngrok, B)
    Implicit
    This member is added by an implicit conversion from Ngrok toArrowAssoc[Ngrok] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. lazy val abuseReports: AbuseReports

    Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.

    Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.

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

    returns

    a service client

  7. lazy val agentIngresses: AgentIngresses

    Creates a service client for AgentIngresses.

    Creates a service client for AgentIngresses.

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

    returns

    a service client

  8. lazy val apiKeys: ApiKeys

    API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API.

    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.

    returns

    a service client

  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. lazy val backends: BackendsNamespace

    Creates a namespace object for Backends.

    Creates a namespace object for Backends.

    returns

    a namespace object

  11. lazy val certificateAuthorities: CertificateAuthorities

    Certificate Authorities are x509 certificates that are used to sign other x509 certificates.

    Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.

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

    returns

    a service client

  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. lazy val credentials: Credentials

    Tunnel Credentials are ngrok agent authtokens.

    Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the ngrok config add-authtoken command or by specifying it in the ngrok.yml configuration file with the authtoken property.

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

    returns

    a service client

  14. lazy val edgeModules: EdgeModulesNamespace

    Creates a namespace object for EdgeModules.

    Creates a namespace object for EdgeModules.

    returns

    a namespace object

  15. lazy val edges: EdgesNamespace

    Creates a namespace object for Edges.

    Creates a namespace object for Edges.

    returns

    a namespace object

  16. lazy val endpoints: Endpoints

    Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport.

    Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned.

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

    returns

    a service client

  17. def ensuring(cond: (Ngrok) => Boolean, msg: => Any): Ngrok
    Implicit
    This member is added by an implicit conversion from Ngrok toEnsuring[Ngrok] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (Ngrok) => Boolean): Ngrok
    Implicit
    This member is added by an implicit conversion from Ngrok toEnsuring[Ngrok] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: => Any): Ngrok
    Implicit
    This member is added by an implicit conversion from Ngrok toEnsuring[Ngrok] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): Ngrok
    Implicit
    This member is added by an implicit conversion from Ngrok toEnsuring[Ngrok] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. lazy val eventDestinations: EventDestinations

    Creates a service client for EventDestinations.

    Creates a service client for EventDestinations.

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

    returns

    a service client

  24. lazy val eventSources: EventSources

    Creates a service client for EventSources.

    Creates a service client for EventSources.

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

    returns

    a service client

  25. lazy val eventSubscriptions: EventSubscriptions

    Creates a service client for EventSubscriptions.

    Creates a service client for EventSubscriptions.

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

    returns

    a service client

  26. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. lazy val ipPolicies: IpPolicies

    IP Policies are reusable groups of CIDR ranges with an allow or deny action.

    IP Policies are reusable groups of CIDR ranges with an allow or deny action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard.

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

    returns

    a service client

  30. lazy val ipPolicyRules: IpPolicyRules

    IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.

    IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.

    See also https://ngrok.com/docs/api#api-ip-policy-rules.

    returns

    a service client

  31. lazy val ipRestrictions: 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 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.

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

    returns

    a service client

  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. lazy val reservedAddrs: ReservedAddrs

    Reserved Addresses are TCP addresses that can be used to listen for traffic.

    Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.

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

    returns

    a service client

  37. lazy val reservedDomains: ReservedDomains

    Reserved Domains are hostnames that you can listen for traffic on.

    Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.

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

    returns

    a service client

  38. lazy val sshCertificateAuthorities: SshCertificateAuthorities

    An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

    An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

    See also https://ngrok.com/docs/api#api-ssh-certificate-authorities.

    returns

    a service client

  39. lazy val sshCredentials: SshCredentials

    SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.

    SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.

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

    returns

    a service client

  40. lazy val sshHostCertificates: SshHostCertificates

    SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.

    SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.

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

    returns

    a service client

  41. lazy val sshUserCertificates: SshUserCertificates

    SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.

    SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.

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

    returns

    a service client

  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. lazy val tlsCertificates: TlsCertificates

    TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.

    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.

    returns

    a service client

  44. def toString(): String
    Definition Classes
    AnyRef → Any
  45. lazy val tunnelSessions: TunnelSessions

    Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.

    Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.

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

    returns

    a service client

  46. lazy val tunnels: Tunnels

    Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.

    Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.

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

    returns

    a service client

  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. 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 Ngrok toStringFormat[Ngrok] 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): (Ngrok, B)
    Implicit
    This member is added by an implicit conversion from Ngrok toArrowAssoc[Ngrok] 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 fromNgrok to any2stringadd[Ngrok]

Inherited by implicit conversion StringFormat fromNgrok to StringFormat[Ngrok]

Inherited by implicit conversion Ensuring fromNgrok to Ensuring[Ngrok]

Inherited by implicit conversion ArrowAssoc fromNgrok to ArrowAssoc[Ngrok]

Ungrouped