All Classes

Class	Description
AgentStatus	An object representing an AgentStatus response from ngrok's API.
AgentStatus.Session	An object representing a nested Session from ngrok's Agent.
AgentStatus.Session.Leg	An object representing a nested Leg from ngrok's Agent Session.
ApiResponse	A response from the ngrok API.
BindTls	An enum representing ngrok's valid bind_tls values, as defined in ngrok's docs.
CapturedRequest	An object representing a CapturedRequest response from ngrok's API.
CapturedRequest.Request	An object representing a nested Request from ngrok's API.
CapturedRequest.Response	An object representing a nested Response from ngrok's API.
CapturedRequests	An object representing CapturedRequests response from ngrok's API.
ConfigVersion	An enum for the list of supported ngrok config versions.
CreateTunnel	An object that represents a ngrok Tunnel creation request.
CreateTunnel.Builder	Builder for a CreateTunnel, which can be used to construct a request that conforms to ngrok's tunnel definition.
DefaultHttpClient	A default client for executing JSON-based HTTP requests.
DefaultHttpClient.Builder	Builder for a DefaultHttpClient, see docs for that class for example usage.
HttpClient	A simple interface for executing HTTP requests.
HttpClientException	Root exception for DefaultHttpClient interactions.
JavaNgrokConfig	An object for managing java-ngrok's configuration to interact the ngrok binary.
JavaNgrokConfig.Builder	Builder for a JavaNgrokConfig, see docs for that class for example usage.
JavaNgrokException	Root exception for the NgrokClient and the java-ngrok library.
JavaNgrokHTTPException	Thrown from NgrokClient when an error occurs making a request to the ngrok web interface.
JavaNgrokInstallerException	Thrown from NgrokInstaller when an error occurs while downloading and installing the ngrok binary.
JavaNgrokSecurityException	Thrown from NgrokProcess when a security error occurs.
JavaNgrokVersion	A singleton object that represents the java-ngrok library version.
NgrokAgent	A client for interaction with the ngrok agent.
NgrokCDNUrl	An interface for getting ngrok download URLs.
NgrokClient	A client for interacting with ngrok, its binary, and its APIs.
NgrokClient.Builder	Builder for a NgrokClient, see docs for that class for example usage.
NgrokException	Thrown from NgrokProcess when an error occurs interacting directly with the ngrok binary.
NgrokInstaller	A helper for downloading and installing ngrok for the current system.
NgrokLog	An object containing a parsed log from the ngrok process.
NgrokProcess	An object containing information about the ngrok process.
NgrokProcess.ProcessMonitor	A Runnable that monitors the ngrok process.
NgrokV2CDNUrl	An enum that maps systems and architectures to their corresponding legacy ngrok V2 download URLs.
NgrokV3CDNUrl	An enum that maps systems and architectures to their corresponding ngrok V3 download URLs.
NgrokVersion	An enum for the list of supported major ngrok versions.
Parameter	A parameter for the HttpClient.
ProcessUtils	Convenience methods for executing processes and capturing their output.
Proto	An enum representing ngrok's valid protos, as defined in ngrok's docs.
Region	An enum representing ngrok's valid regions, as defined in ngrok's docs.
Response<T>	A response from the HttpClient.
StringUtils	Convenience methods for String manipulation.
Tunnel	An object representing a Tunnel response from ngrok's API.
Tunnel.Metrics	An object representing a nested Metrics from ngrok's API.
Tunnel.TunnelConfig	An object representing a nested TunnelConfig from ngrok's API.
TunnelHeader	An object that represents header configuration for a CreateTunnel.
TunnelHeader.Builder	Builder for a TunnelHeader.
TunnelIPRestriction	An object that represents IP restriction for a CreateTunnel.
TunnelIPRestriction.Builder	Builder for a TunnelIPRestriction.
TunnelOAuth	An object that represents the OAuth configuration for a CreateTunnel.
TunnelOAuth.Builder	Builder for OAuth configuration that conforms to ngrok's tunnel definition.
TunnelPolicy	An object that represents policy configuration for a CreateTunnel.
TunnelPolicy.Builder	Builder for a TunnelPolicy.
TunnelPolicyActions	An object that represents policy actions configuration for a CreateTunnel.
TunnelPolicyActions.Builder	Builder for a TunnelPolicyActions.
Tunnels	An object representing a Tunnels response from ngrok's API.
TunnelUserAgentFilter	An object that represents UserAgent filter for a CreateTunnel.
TunnelUserAgentFilter.Builder	Builder for a TunnelUserAgentFilter.
TunnelVerifyWebhook	An object that represents webhook signature verification for a CreateTunnel.
TunnelVerifyWebhook.Builder	Builder for a TunnelVerifyWebhook.
Version	An object representing ngrok's version and java-ngrok's version.