What are Internal Endpoints?
Internal Endpoints are private endpoints that only receive traffic when forwarded through the forward-internal
traffic policy action. This allows you to route traffic to an application through ngrok without making it publicly addressable.
Internal endpoint URLs must:
- End with the
.internal
domain extension - Use the
internal
binding
A common practice is to use a public cloud endpoints to manage a centralized Traffic Policy, then forward traffic to one or more internal endpoints. See the guide on using cloud endpoints with internal endpoints to learn more.
Get started
See the quickstart to create your first Internal Endpoint.
Type and Pooling
Internal endpoints support:
- Both Endpoint Types:
agent
andcloud
. - Endpoint Pooling.
HTTP/S on_tcp_connect
phase
For internal http
and https
endpoints, the on_tcp_connect
Traffic Policy phase is not applicable and never triggers.
This is because when you use the forward-internal
action to forward traffic to an http
or https
endpoint, no new TCP connection is established. For additional details, see the forward-internal
documentation.
API
Internal endpoints can be managed programatically. To get started, consult the Endpoints API documentation.
Pricing
Internal endpoints are available on the Pay-as-you-go plan. Consult the Endpoints Pricing documentation for billing details.