Skip to main content

Endpoint Types

The ngrok Kubernetes operator offers CloudEndpoint and AgentEndpoint as custom resource types that let you create endpoints in ngrok. The using CRDs guide goes over the details and differences about how to configure each one. This page covers the different types of endpoints that can be created using either CloudEndpoint or AgentEndpoint.

HTTP Endpoints​

The following examples showcase how you can create endpoints that accept http:// cleartext requests.

The example showcases an upstream that accepts http:// requests, but you can also use https:// for the upstream. For AgentEndpoints, the upstream.url scheme does not need to match the scheme of the public URL.

Loading…

HTTPS Endpoints​

The following examples showcase how you can create endpoints that accept https:// encrypted requests. For HTTPS endpoints, ngrok will automatically terminate TLS connections for your HTTPS endpoints. If you would like to control yourself, you can use the terminate-tls traffic policy action.

The example showcases an upstream that accepts https:// requests, but you can also use http:// for the upstream. For AgentEndpoints, the upstream.url scheme does not need to match the scheme of the public URL.

Loading…

TCP Endpoints​

The following examples showcase how you can create endpoints that accept tcp:// requests. TCP Endpoints can be used to forward raw TCP traffic. In order to create a TCP Endpoint, you must first reserve a TCP address through the ngrok dashboard. This step is not necessary for internal endpoints. See the bindings page for more information about public/internal/k8s endpoints.

The example showcases an upstream that accepts tcp:// requests, but you can also use tls:// for the upstream. For AgentEndpoints, the upstream.url scheme does not need to match the scheme of the public URL.

Loading…

TLS Endpoints​

The following examples showcase how you can create endpoints that accept tls:// requests. TLS endpoints enable you to deliver any network service that runs over a TLS-based protocol. TLS endpoints make no assumptions about the wrapped protocol being transported.

For TLS endpoints, ngrok will not terminate the TLS connection by default and it is up to you to handle TLS termination in your upstream service.

Loading…