Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ngrok.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Redirects allow you to seamlessly route users from one URL to another, ensuring they always reach the correct destination. They are commonly used for: 🔄 Preserving SEO rankings when URLs change.
🔐 Enforcing secure HTTPS connections.
🌍 Directing traffic to localized versions of a site.

​
🔍 What are the benefits of redirects?

Redirects help optimize user experience and security by ensuring that visitors always land on the correct and most relevant page. Key Benefits:
  • Ensure Seamless URL Changes: Automatically direct users to new pages when URLs change.
  • Enforce HTTPS: Redirect HTTP traffic to secure HTTPS connections.
  • Improve SEO & Preserve Link Equity: Avoid broken links that impact search engine rankings.
  • Handle Legacy URLs: Maintain compatibility with old URLs or deprecated endpoints.
  • Enhance User Experience: Automatically direct visitors to localized or mobile-friendly versions of your site.

​
Redirect full path

The following examples showcase how to create an endpoint that redirects requests. The hostname, scheme, and port are kept the same, but the entire path of the request is changed.
  • Requests to https://example-hostname.ngrok.io/example will be redirected to https://example-hostname.ngrok.io/redirect
  • Requests to https://example-hostname.ngrok.io/example/foo will be redirected to https://example-hostname.ngrok.io/redirect
Check out the redirect Traffic Policy action page for more details about how it functions and the parameters it accepts.
apiVersion: ngrok.k8s.ngrok.com/v1alpha1
kind: AgentEndpoint
metadata:
  name: example-agent-endpoint
spec:
  url: https://example-hostname.ngrok.io
  upstream:
    url: http://my-service.my-namespace:8080
  trafficPolicy:
    inline:
      on_http_request:
        - actions:
            - type: redirect
              config:
                from: /.*
                to: /redirect

​
Redirect path prefix

The following examples showcase how to create an endpoint that redirects requests. The hostname, scheme, and port are kept the same, but only the prefix is changed.
  • Requests to https://example-hostname.ngrok.io/example will be redirected to https://example-hostname.ngrok.io/redirect
  • Requests to https://example-hostname.ngrok.io/example/foo will be redirected to https://example-hostname.ngrok.io/redirect/foo
Check out the redirect Traffic Policy action page for more details about how it functions and the parameters it accepts.
apiVersion: ngrok.k8s.ngrok.com/v1alpha1
kind: AgentEndpoint
metadata:
  name: example-agent-endpoint
spec:
  url: https://example-hostname.ngrok.io
  upstream:
    url: http://my-service.my-namespace:8080
  trafficPolicy:
    inline:
      on_http_request:
        - actions:
            - type: redirect
              config:
                from: /example(.*)
                to: /redirect$1

​
Redirect port

The following examples showcase how to create an endpoint that redirects requests. The hostname, scheme, and path are kept the same, but only the port is changed.
  • Requests to http://example-hostname.ngrok.io:8080 will be redirected to http://example-hostname.ngrok.io:9090
Check out the redirect Traffic Policy action page for more details about how it functions and the parameters it accepts.
apiVersion: ngrok.k8s.ngrok.com/v1alpha1
kind: AgentEndpoint
metadata:
  name: example-agent-endpoint
spec:
  url: http://example-hostname.ngrok.io:8080
  upstream:
    url: http://my-service.my-namespace:8080
  trafficPolicy:
    inline:
      on_http_request:
        - actions:
            - type: redirect
              config:
                from: :8080
                to: :9090

​
Redirect hostname

The following examples showcase how to create an endpoint that redirects requests. The scheme, port, and path are kept the same, but only the hostname is changed.
  • Requests to https://example-hostname.ngrok.io will be redirected to https://other-example-hostname.ngrok.io
Check out the redirect Traffic Policy action page for more details about how it functions and the parameters it accepts.
apiVersion: ngrok.k8s.ngrok.com/v1alpha1
kind: AgentEndpoint
metadata:
  name: example-agent-endpoint
spec:
  url: https://example-hostname.ngrok.io
  upstream:
    url: http://my-service.my-namespace:8080
  trafficPolicy:
    inline:
      on_http_request:
        - actions:
            - type: redirect
              config:
                from: example-hostname.ngrok.io
                to: other-example-hostname.ngrok.io