Forward Internal

Overview

The Forward Internal Traffic Policy action enables you to forward requests from an Endpoint to a Private Endpoint.

Configuration Reference

This is the Traffic Policy configuration reference for this action.

Action Type

forward-internal

Configuration Fields

Parameter	Type	Description
binding	string	The string private.
url	string	Required. The endpoint to forward to, such as http://my-private-endpoint.private:1234
on_error	'halt' | 'continue'	Whether a forward error is terminal (halts the action), or whether the policy continues to process later actions on error.

Supported Directions

• inbound

Supported Schemes

• https
• http
• tcp
• tls

Behavior

This action forwards a request to a private endpoint.

Valid forward targets

A request may only be forwarded to a private endpoint on the same account as this endpoint.

The target must be of the same protocol (i.e. an HTTP Endpoint may only forward to an HTTP Private Endpoint).

Examples

Rewrite using Paths

The following Traffic Policy configuration demonstrates how to use the forward-internal action to forward to a Private Endpoint.

Example Traffic Policy Document

YAML

---
inbound:
  - actions:
      - type: "forward-internal"
        config:
          binding: "private"
          url: "http://my-endpoint.private"

JSON

{
  "inbound": [
    {
      "actions": [
        {
          "type": "forward-internal",
          "config": {
            "binding": "private",
            "url": "http://my-endpoint.private"
          }
        }
      ]
    }
  ]
}

This configuration will forward requests to an agent started with ngrok http --url "http://my-endpoint.private" 80