# All Classes and Interfaces

Class
Description
AbuseReport
A class encapsulating the `AbuseReport` resource.
AbuseReportHostname
A class encapsulating the `AbuseReportHostname` resource.
AbuseReports
Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.
AgentIngress
A class encapsulating the `AgentIngress` resource.
AgentIngresses
An API client for `AgentIngresses`.
AgentIngressList
A class encapsulating the `AgentIngressList` resource.
ApiKey
A class encapsulating the `ApiKey` resource.
ApiKeyList
A class encapsulating the `ApiKeyList` resource.
ApiKeys
API Keys are used to authenticate to the ngrok API.
AwsAuth
A class encapsulating the `AwsAuth` resource.
AwsAuth.Builder
Builder class for `AwsAuth`.
AwsCredentials
A class encapsulating the `AwsCredentials` resource.
AwsCredentials.Builder
Builder class for `AwsCredentials`.
AwsRole
A class encapsulating the `AwsRole` resource.
AwsRole.Builder
Builder class for `AwsRole`.
CertificateAuthorities
Certificate Authorities are x509 certificates that are used to sign other x509 certificates.
CertificateAuthority
A class encapsulating the `CertificateAuthority` resource.
CertificateAuthorityList
A class encapsulating the `CertificateAuthorityList` resource.
Credential
A class encapsulating the `Credential` resource.
CredentialList
A class encapsulating the `CredentialList` resource.
Credentials
Tunnel Credentials are ngrok agent authtokens.
DefaultNgrokApiClient
Default implementation of `NgrokApiClient` based on the Armeria HTTP client.
DefaultNgrokApiClient.Builder
Builder class for the default API client.
EdgeRouteBackendModule
An API client for `EdgeRouteBackendModule`.
EdgeRouteCircuitBreakerModule
An API client for `EdgeRouteCircuitBreakerModule`.
EdgeRouteCompressionModule
An API client for `EdgeRouteCompressionModule`.
EdgeRouteIpRestrictionModule
An API client for `EdgeRouteIpRestrictionModule`.
EdgeRouteOAuthModule
An API client for `EdgeRouteOAuthModule`.
EdgeRouteOidcModule
An API client for `EdgeRouteOidcModule`.
EdgeRouteRequestHeadersModule
An API client for `EdgeRouteRequestHeadersModule`.
EdgeRouteResponseHeadersModule
An API client for `EdgeRouteResponseHeadersModule`.
EdgeRouteSamlModule
An API client for `EdgeRouteSamlModule`.
EdgeRouteWebhookVerificationModule
An API client for `EdgeRouteWebhookVerificationModule`.
EdgeRouteWebsocketTcpConverterModule
An API client for `EdgeRouteWebsocketTcpConverterModule`.
EdgesHttps
An API client for `EdgesHttps`.
EdgesHttpsRoutes
An API client for `EdgesHttpsRoutes`.
EdgesTcp
An API client for `EdgesTcp`.
EdgesTls
An API client for `EdgesTls`.
Endpoint
A class encapsulating the `Endpoint` resource.
EndpointBackend
A class encapsulating the `EndpointBackend` resource.
EndpointBackendMutate
A class encapsulating the `EndpointBackendMutate` resource.
EndpointBackendMutate.Builder
Builder class for `EndpointBackendMutate`.
EndpointCircuitBreaker
A class encapsulating the `EndpointCircuitBreaker` resource.
EndpointCircuitBreaker.Builder
Builder class for `EndpointCircuitBreaker`.
EndpointCompression
A class encapsulating the `EndpointCompression` resource.
EndpointCompression.Builder
Builder class for `EndpointCompression`.
EndpointIpPolicy
A class encapsulating the `EndpointIpPolicy` resource.
EndpointIpPolicyMutate
A class encapsulating the `EndpointIpPolicyMutate` resource.
EndpointIpPolicyMutate.Builder
Builder class for `EndpointIpPolicyMutate`.
EndpointList
A class encapsulating the `EndpointList` resource.
EndpointMutualTls
A class encapsulating the `EndpointMutualTls` resource.
EndpointMutualTlsMutate
A class encapsulating the `EndpointMutualTlsMutate` resource.
EndpointMutualTlsMutate.Builder
Builder class for `EndpointMutualTlsMutate`.
EndpointOAuth
A class encapsulating the `EndpointOAuth` resource.
EndpointOAuth.Builder
Builder class for `EndpointOAuth`.
EndpointOAuthFacebook
A class encapsulating the `EndpointOAuthFacebook` resource.
EndpointOAuthFacebook.Builder
Builder class for `EndpointOAuthFacebook`.
EndpointOAuthGitHub
A class encapsulating the `EndpointOAuthGitHub` resource.
EndpointOAuthGitHub.Builder
Builder class for `EndpointOAuthGitHub`.
EndpointOAuthGoogle
A class encapsulating the `EndpointOAuthGoogle` resource.
EndpointOAuthGoogle.Builder
Builder class for `EndpointOAuthGoogle`.
EndpointOAuthMicrosoft
A class encapsulating the `EndpointOAuthMicrosoft` resource.
EndpointOAuthMicrosoft.Builder
Builder class for `EndpointOAuthMicrosoft`.
EndpointOAuthProvider
A class encapsulating the `EndpointOAuthProvider` resource.
EndpointOAuthProvider.Builder
Builder class for `EndpointOAuthProvider`.
EndpointOidc
A class encapsulating the `EndpointOidc` resource.
EndpointOidc.Builder
Builder class for `EndpointOidc`.
EndpointRequestHeaders
A class encapsulating the `EndpointRequestHeaders` resource.
EndpointRequestHeaders.Builder
Builder class for `EndpointRequestHeaders`.
EndpointResponseHeaders
A class encapsulating the `EndpointResponseHeaders` resource.
EndpointResponseHeaders.Builder
Builder class for `EndpointResponseHeaders`.
Endpoints
Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport.
EndpointSaml
A class encapsulating the `EndpointSaml` resource.
EndpointSamlMutate
A class encapsulating the `EndpointSamlMutate` resource.
EndpointSamlMutate.Builder
Builder class for `EndpointSamlMutate`.
EndpointTlsTermination
A class encapsulating the `EndpointTlsTermination` resource.
EndpointTlsTermination.Builder
Builder class for `EndpointTlsTermination`.
EndpointTlsTerminationAtEdge
A class encapsulating the `EndpointTlsTerminationAtEdge` resource.
EndpointTlsTerminationAtEdge.Builder
Builder class for `EndpointTlsTerminationAtEdge`.
EndpointWebhookValidation
A class encapsulating the `EndpointWebhookValidation` resource.
EndpointWebhookValidation.Builder
Builder class for `EndpointWebhookValidation`.
EndpointWebsocketTcpConverter
A class encapsulating the `EndpointWebsocketTcpConverter` resource.
EndpointWebsocketTcpConverter.Builder
Builder class for `EndpointWebsocketTcpConverter`.
EventDestination
A class encapsulating the `EventDestination` resource.
EventDestinationList
A class encapsulating the `EventDestinationList` resource.
EventDestinations
An API client for `EventDestinations`.
EventSource
A class encapsulating the `EventSource` resource.
EventSourceList
A class encapsulating the `EventSourceList` resource.
EventSourceReplace
A class encapsulating the `EventSourceReplace` resource.
EventSourceReplace.Builder
Builder class for `EventSourceReplace`.
EventSources
An API client for `EventSources`.
EventSubscription
A class encapsulating the `EventSubscription` resource.
EventSubscriptionList
A class encapsulating the `EventSubscriptionList` resource.
EventSubscriptions
An API client for `EventSubscriptions`.
EventTarget
A class encapsulating the `EventTarget` resource.
EventTarget.Builder
Builder class for `EventTarget`.
EventTargetCloudwatchLogs
A class encapsulating the `EventTargetCloudwatchLogs` resource.
EventTargetCloudwatchLogs.Builder
Builder class for `EventTargetCloudwatchLogs`.
EventTargetFirehose
A class encapsulating the `EventTargetFirehose` resource.
EventTargetFirehose.Builder
Builder class for `EventTargetFirehose`.
EventTargetKinesis
A class encapsulating the `EventTargetKinesis` resource.
EventTargetKinesis.Builder
Builder class for `EventTargetKinesis`.
FailoverBackend
A class encapsulating the `FailoverBackend` resource.
FailoverBackendList
A class encapsulating the `FailoverBackendList` resource.
FailoverBackends
A Failover backend defines failover behavior within a list of referenced backends.
HttpResponseBackend
A class encapsulating the `HttpResponseBackend` resource.
HttpResponseBackendList
A class encapsulating the `HttpResponseBackendList` resource.
HttpResponseBackends
An API client for `HttpResponseBackends`.
HttpsEdge
A class encapsulating the `HttpsEdge` resource.
HttpsEdgeList
A class encapsulating the `HttpsEdgeList` resource.
HttpsEdgeMutualTlsModule
An API client for `HttpsEdgeMutualTlsModule`.
HttpsEdgeRoute
A class encapsulating the `HttpsEdgeRoute` resource.
HttpsEdgeTlsTerminationModule
An API client for `HttpsEdgeTlsTerminationModule`.
IpPolicies
IP Policies are reusable groups of CIDR ranges with an `allow` or `deny` action.
IpPolicy
A class encapsulating the `IpPolicy` resource.
IpPolicyList
A class encapsulating the `IpPolicyList` resource.
IpPolicyRule
A class encapsulating the `IpPolicyRule` resource.
IpPolicyRuleList
A class encapsulating the `IpPolicyRuleList` resource.
IpPolicyRules
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.
IpRestriction
A class encapsulating the `IpRestriction` resource.
IpRestrictionList
A class encapsulating the `IpRestrictionList` resource.
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.
Ngrok
Main entry point for the ngrok API.
NgrokApiClient
API client interface.
NgrokApiClient.HttpMethod
HTTP request methods
NgrokApiError
Representation of an API error from ngrok.
Page<T extends Pageable>
Wrapper class that holds a single page of a `Pageable` response.
Pageable
Interface indicating a resource type that can have more than one page of responses.
Ref
A class encapsulating the `Ref` resource.
ReservedAddr
A class encapsulating the `ReservedAddr` resource.
ReservedAddrList
A class encapsulating the `ReservedAddrList` resource.
ReservedAddrs
Reserved Addresses are TCP addresses that can be used to listen for traffic.
ReservedDomain
A class encapsulating the `ReservedDomain` resource.
ReservedDomainCertJob
A class encapsulating the `ReservedDomainCertJob` resource.
ReservedDomainCertPolicy
A class encapsulating the `ReservedDomainCertPolicy` resource.
ReservedDomainCertPolicy.Builder
Builder class for `ReservedDomainCertPolicy`.
ReservedDomainCertStatus
A class encapsulating the `ReservedDomainCertStatus` resource.
ReservedDomainList
A class encapsulating the `ReservedDomainList` resource.
ReservedDomains
Reserved Domains are hostnames that you can listen for traffic on.
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.
SshCertificateAuthority
A class encapsulating the `SshCertificateAuthority` resource.
SshCertificateAuthorityList
A class encapsulating the `SshCertificateAuthorityList` resource.
SshCredential
A class encapsulating the `SshCredential` resource.
SshCredentialList
A class encapsulating the `SshCredentialList` resource.
SshCredentials
SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.
SshHostCertificate
A class encapsulating the `SshHostCertificate` resource.
SshHostCertificateList
A class encapsulating the `SshHostCertificateList` resource.
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.
SshUserCertificate
A class encapsulating the `SshUserCertificate` resource.
SshUserCertificateList
A class encapsulating the `SshUserCertificateList` resource.
SshUserCertificates
SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.
TcpEdge
A class encapsulating the `TcpEdge` resource.
TcpEdgeBackendModule
An API client for `TcpEdgeBackendModule`.
TcpEdgeIpRestrictionModule
An API client for `TcpEdgeIpRestrictionModule`.
TcpEdgeList
A class encapsulating the `TcpEdgeList` resource.
TlsCertificate
A class encapsulating the `TlsCertificate` resource.
TlsCertificateList
A class encapsulating the `TlsCertificateList` resource.
TlsCertificates
TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.
TlsCertificateSaNs
A class encapsulating the `TlsCertificateSaNs` resource.
TlsEdge
A class encapsulating the `TlsEdge` resource.
TlsEdgeBackendModule
An API client for `TlsEdgeBackendModule`.
TlsEdgeIpRestrictionModule
An API client for `TlsEdgeIpRestrictionModule`.
TlsEdgeList
A class encapsulating the `TlsEdgeList` resource.
TlsEdgeMutualTlsModule
An API client for `TlsEdgeMutualTlsModule`.
TlsEdgeTlsTerminationModule
An API client for `TlsEdgeTlsTerminationModule`.
Tunnel
A class encapsulating the `Tunnel` resource.
TunnelGroupBackend
A class encapsulating the `TunnelGroupBackend` resource.
TunnelGroupBackendList
A class encapsulating the `TunnelGroupBackendList` resource.
TunnelGroupBackends
A Tunnel Group Backend balances traffic among all online tunnels that match a label selector.
TunnelList
A class encapsulating the `TunnelList` resource.
Tunnels
Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.
TunnelSession
A class encapsulating the `TunnelSession` resource.
TunnelSessionList
A class encapsulating the `TunnelSessionList` resource.
TunnelSessions
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.
Version
Client version information
WeightedBackend
A class encapsulating the `WeightedBackend` resource.
WeightedBackendList
A class encapsulating the `WeightedBackendList` resource.
WeightedBackends
A Weighted Backend balances traffic among the referenced backends.