Forward proxies provide a single point through which multiple machines send requests to an
external server. They can enforce security policies, log and analyze requests, and perform other
actions so that requests adhere to your business rules. With Apigee hybrid, you can configure a forward proxy
that intermediates your API proxies and an external TargetEndpoint (a backend target server).
To use an HTTP forward proxy between hybrid and the TargetEndpoint, you must configure
the outbound proxy settings in your overrides file. These environment-scoped properties
route target requests from hybrid to the HTTP forward proxy. You also need to ensure
use.proxy is set to "true" for any TargetEndpoint that you want to go through an HTTP
forward proxy. See the bottom of the page for instructions.
To configure a hybrid environment for forwarding proxying, add
the envs.httpProxy property to your overrides file and apply it to the
cluster. For example:
Forward proxying is configured for an environment; all traffic going from API
proxies in that environment to backend targets goes through the specified HTTP
forward proxy. If the traffic for a
specific target of an API proxy should go directly to the backend target, bypassing the forward
proxy, then set the following property in the TargetEndpoint to override the HTTP forward
proxy:
<Property name="use.proxy">false</Property>
For more information on setting the TargetEndpoint properties, including how to configure
the connection to the target endpoint, see Endpoint properties reference.
Set use.proxy to "true" for any TargetEndpoint that you want to go through
an HTTP forward proxy:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[[["\u003cp\u003eThis documentation covers version 1.8 of Apigee hybrid, which is no longer supported and requires upgrading to a newer version.\u003c/p\u003e\n"],["\u003cp\u003eApigee hybrid can be configured with a forward proxy to manage and control requests from API proxies to external TargetEndpoints.\u003c/p\u003e\n"],["\u003cp\u003eTo utilize a forward proxy, the \u003ccode\u003eenvs.httpProxy\u003c/code\u003e property must be configured in the overrides file with details such as scheme, host, and port.\u003c/p\u003e\n"],["\u003cp\u003eTraffic from API proxies in a configured environment will go through the specified forward proxy unless the \u003ccode\u003euse.proxy\u003c/code\u003e property in the TargetEndpoint is set to "false".\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003euse.proxy\u003c/code\u003e property in the TargetEndpoint must be set to "true" for requests to utilize the defined HTTP forward proxy.\u003c/p\u003e\n"]]],[],null,["# Configure forward proxying for API proxies\n\n| You are currently viewing version 1.8 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](/apigee/docs/hybrid/supported-platforms#supported-versions).\n\nForward proxies provide a single point through which multiple machines send requests to an\nexternal server. They can enforce security policies, log and analyze requests, and perform other\nactions so that requests adhere to your business rules. With Apigee hybrid, you can configure a forward proxy\nthat intermediates your API proxies and an external TargetEndpoint (a backend target server).\n\nTo use an HTTP forward proxy between hybrid and the TargetEndpoint, you must configure\nthe outbound proxy settings in your overrides file. These environment-scoped properties\nroute target requests from hybrid to the HTTP forward proxy. You also need to ensure\n`use.proxy` is set to \"true\" for any TargetEndpoint that you want to go through an HTTP\nforward proxy. See the bottom of the page for instructions.\n\nTo configure a hybrid environment for forwarding proxying, add\nthe [`envs.httpProxy` property](/apigee/docs/hybrid/v1.8/config-prop-ref#envs) to your overrides file and apply it to the\ncluster. For example: \n\n```text\nenvs:\n - name: test\n httpProxy:\n scheme: HTTP\n host: 10.12.0.47\n port: 3128\n ...\n```\n| **NOTE:** The `scheme` can be HTTP or HTTPS and must be uppercase.\n\nFor details on each of the `envs.httpProxy` configuration properties refer to the\n[Configuration property reference](/apigee/docs/hybrid/v1.8/config-prop-ref#envs).\n\nForward proxying is configured for an environment; all traffic going from API\nproxies in that environment to backend targets goes through the specified HTTP\nforward proxy. If the traffic for a\nspecific target of an API proxy should go directly to the backend target, bypassing the forward\nproxy, then set the following property in the TargetEndpoint to override the HTTP forward\nproxy: \n\n```text\n\u003cProperty name=\"use.proxy\"\u003efalse\u003c/Property\u003e\n```\n\nFor more information on setting the TargetEndpoint properties, including how to configure\nthe connection to the target endpoint, see [Endpoint properties reference](/apigee/docs/api-platform/reference/endpoint-properties-reference).\n\nSet `use.proxy` to \"true\" for any TargetEndpoint that you want to go through\nan HTTP forward proxy: \n\n```text\n\u003cProperty name=\"use.proxy\"\u003etrue\u003c/Property\u003e\n```"]]
