package services
- Alphabetic
- By Inheritance
- services
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- class AbuseReports extends AnyRef
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.
- class AgentIngresses extends AnyRef
An API client for AgentIngresses.
An API client for AgentIngresses.
- class ApiKeys extends AnyRef
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.
- class CertificateAuthorities extends AnyRef
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.
- class Credentials extends AnyRef
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-authtokencommand or by specifying it in thengrok.ymlconfiguration file with theauthtokenproperty. - class EdgeRouteBackendModule extends AnyRef
An API client for EdgeRouteBackendModule.
An API client for EdgeRouteBackendModule.
See also https://ngrok.com/docs/api#api-edge-route-backend-module.
- class EdgeRouteCircuitBreakerModule extends AnyRef
An API client for EdgeRouteCircuitBreakerModule.
An API client for EdgeRouteCircuitBreakerModule.
See also https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module.
- class EdgeRouteCompressionModule extends AnyRef
An API client for EdgeRouteCompressionModule.
An API client for EdgeRouteCompressionModule.
See also https://ngrok.com/docs/api#api-edge-route-compression-module.
- class EdgeRouteIpRestrictionModule extends AnyRef
An API client for EdgeRouteIpRestrictionModule.
An API client for EdgeRouteIpRestrictionModule.
See also https://ngrok.com/docs/api#api-edge-route-ip-restriction-module.
- class EdgeRouteOAuthModule extends AnyRef
An API client for EdgeRouteOAuthModule.
An API client for EdgeRouteOAuthModule.
See also https://ngrok.com/docs/api#api-edge-route-o-auth-module.
- class EdgeRouteOidcModule extends AnyRef
An API client for EdgeRouteOidcModule.
An API client for EdgeRouteOidcModule.
See also https://ngrok.com/docs/api#api-edge-route-oidc-module.
- class EdgeRouteRequestHeadersModule extends AnyRef
An API client for EdgeRouteRequestHeadersModule.
An API client for EdgeRouteRequestHeadersModule.
See also https://ngrok.com/docs/api#api-edge-route-request-headers-module.
- class EdgeRouteResponseHeadersModule extends AnyRef
An API client for EdgeRouteResponseHeadersModule.
An API client for EdgeRouteResponseHeadersModule.
See also https://ngrok.com/docs/api#api-edge-route-response-headers-module.
- class EdgeRouteSamlModule extends AnyRef
An API client for EdgeRouteSamlModule.
An API client for EdgeRouteSamlModule.
See also https://ngrok.com/docs/api#api-edge-route-saml-module.
- class EdgeRouteWebhookVerificationModule extends AnyRef
An API client for EdgeRouteWebhookVerificationModule.
An API client for EdgeRouteWebhookVerificationModule.
See also https://ngrok.com/docs/api#api-edge-route-webhook-verification-module.
- class EdgeRouteWebsocketTcpConverterModule extends AnyRef
An API client for EdgeRouteWebsocketTcpConverterModule.
An API client for EdgeRouteWebsocketTcpConverterModule.
See also https://ngrok.com/docs/api#api-edge-route-websocket-tcp-converter-module.
- class EdgesHttps extends AnyRef
An API client for EdgesHttps.
An API client for EdgesHttps.
- class EdgesHttpsRoutes extends AnyRef
An API client for EdgesHttpsRoutes.
An API client for EdgesHttpsRoutes.
- class EdgesTcp extends AnyRef
An API client for EdgesTcp.
An API client for EdgesTcp.
See also https://ngrok.com/docs/api#api-edges-tcp.
- class EdgesTls extends AnyRef
An API client for EdgesTls.
An API client for EdgesTls.
See also https://ngrok.com/docs/api#api-edges-tls.
- class Endpoints extends AnyRef
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.
- class EventDestinations extends AnyRef
An API client for EventDestinations.
An API client for EventDestinations.
- class EventSources extends AnyRef
An API client for EventSources.
An API client for EventSources.
- class EventSubscriptions extends AnyRef
An API client for EventSubscriptions.
An API client for EventSubscriptions.
See also https://ngrok.com/docs/api#api-event-subscriptions.
- class FailoverBackends extends AnyRef
A Failover backend defines failover behavior within a list of referenced backends.
A Failover backend defines failover behavior within a list of referenced backends. Traffic is sent to the first backend in the list. If that backend is offline or no connection can be established, ngrok attempts to connect to the next backend in the list until one is successful.
- class HttpResponseBackends extends AnyRef
An API client for HttpResponseBackends.
An API client for HttpResponseBackends.
See also https://ngrok.com/docs/api#api-http-response-backends.
- class HttpsEdgeMutualTlsModule extends AnyRef
An API client for HttpsEdgeMutualTlsModule.
An API client for HttpsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module.
- class HttpsEdgeTlsTerminationModule extends AnyRef
An API client for HttpsEdgeTlsTerminationModule.
An API client for HttpsEdgeTlsTerminationModule.
See also https://ngrok.com/docs/api#api-https-edge-tls-termination-module.
- class IpPolicies extends AnyRef
IP Policies are reusable groups of CIDR ranges with an
allowordenyaction.IP Policies are reusable groups of CIDR ranges with an
allowordenyaction. 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. - class IpPolicyRules extends AnyRef
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.
- 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 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.
- class ReservedAddrs extends AnyRef
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.
- class ReservedDomains extends AnyRef
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.
- class SshCertificateAuthorities extends AnyRef
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.
- class SshCredentials extends AnyRef
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.
- class SshHostCertificates extends AnyRef
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.
- class SshUserCertificates extends AnyRef
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.
- class TcpEdgeBackendModule extends AnyRef
An API client for TcpEdgeBackendModule.
An API client for TcpEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module.
- class TcpEdgeIpRestrictionModule extends AnyRef
An API client for TcpEdgeIpRestrictionModule.
An API client for TcpEdgeIpRestrictionModule.
See also https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module.
- 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 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.
- class TlsEdgeBackendModule extends AnyRef
An API client for TlsEdgeBackendModule.
An API client for TlsEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tls-edge-backend-module.
- class TlsEdgeIpRestrictionModule extends AnyRef
An API client for TlsEdgeIpRestrictionModule.
An API client for TlsEdgeIpRestrictionModule.
See also https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module.
- class TlsEdgeMutualTlsModule extends AnyRef
An API client for TlsEdgeMutualTlsModule.
An API client for TlsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module.
- class TlsEdgeTlsTerminationModule extends AnyRef
An API client for TlsEdgeTlsTerminationModule.
An API client for TlsEdgeTlsTerminationModule.
See also https://ngrok.com/docs/api#api-tls-edge-tls-termination-module.
- class TunnelGroupBackends extends AnyRef
A Tunnel Group Backend balances traffic among all online tunnels that match a label selector.
A Tunnel Group Backend balances traffic among all online tunnels that match a label selector.
See also https://ngrok.com/docs/api#api-tunnel-group-backends.
- class TunnelSessions extends AnyRef
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.
- class Tunnels extends AnyRef
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.
- class WeightedBackends extends AnyRef
A Weighted Backend balances traffic among the referenced backends.
A Weighted Backend balances traffic among the referenced backends. Traffic is assigned proportionally to each based on its weight. The percentage of traffic is calculated by dividing a backend's weight by the sum of all weights.
Value Members
- object AbuseReports
- object AgentIngresses
- object ApiKeys
- object CertificateAuthorities
- object Credentials
- object EdgeRouteBackendModule
- object EdgeRouteCircuitBreakerModule
- object EdgeRouteCompressionModule
- object EdgeRouteIpRestrictionModule
- object EdgeRouteOAuthModule
- object EdgeRouteOidcModule
- object EdgeRouteRequestHeadersModule
- object EdgeRouteResponseHeadersModule
- object EdgeRouteSamlModule
- object EdgeRouteWebhookVerificationModule
- object EdgeRouteWebsocketTcpConverterModule
- object EdgesHttps
- object EdgesHttpsRoutes
- object EdgesTcp
- object EdgesTls
- object Endpoints
- object EventDestinations
- object EventSources
- object EventSubscriptions
- object FailoverBackends
- object HttpResponseBackends
- object HttpsEdgeMutualTlsModule
- object HttpsEdgeTlsTerminationModule
- object IpPolicies
- object IpPolicyRules
- object IpRestrictions
- object ReservedAddrs
- object ReservedDomains
- object SshCertificateAuthorities
- object SshCredentials
- object SshHostCertificates
- object SshUserCertificates
- object TcpEdgeBackendModule
- object TcpEdgeIpRestrictionModule
- object TlsCertificates
- object TlsEdgeBackendModule
- object TlsEdgeIpRestrictionModule
- object TlsEdgeMutualTlsModule
- object TlsEdgeTlsTerminationModule
- object TunnelGroupBackends
- object TunnelSessions
- object Tunnels
- object WeightedBackends