Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Understanding the handling of request and response data

When you make a request to an API proxy, you can pass any or all of the following information, depending on the way the API proxy is configured:

  • Request headers
  • Query params
  • Form data
  • XML or JSON payloads
  • Resource URIs

By default, all data in a request is passed unchanged from the ProxyEndpoint to the TargetEndpoint. Therefore, when the TargetEndpoint makes the request to the backend server, all information in the original request is passed to the backend service.

The same is true for the response received by Edge from the backend service. By default, all data received in the response is passed unchanged to the app that originated the request. 

How request data passed to the backend server?

The following image shows an API proxy definition:

For this API proxy:

  • API proxy virtual host: default
  • Domain defined by the virtual host:
  • Proxy base path: /v1/weather
  • TargetEndpoint specifid by route rule: default
  • Target URL:

A client app then makes a GET request to the API proxy by using the following cURL command:

curl -X GET

Notice that this request contains the resource "forecastrss" and one query param, "w". Edge parses the request as shown below and assigns parts of the request to flow variables:

{request.verb} {proxy.basepath}/{proxy.pathsuffix}?{request.querystring}

The flow variables are set with the following values:

  • request.verb: GET

  • proxy.basepath: /v1/weather

  • proxy.pathsuffixforecastrss

  • request.querystringw=12797282

There are many different flow variables created during the processing of a request and response. See Variables reference for more.

The TargetEndpoint then makes a request to the backend service using information from the request:

{request.verb} {target.basepath}/{proxy.pathsuffix}?{request.querystring}

Notice how the resource and query params specified in the request are automatically included in the request to the backend server. From the definition of the TargetEndpoint, the request then has the form:

curl -X GET

Like query params, any headers or form params that you include in the request to the API proxy are passed on to the backend server. For example, you make the request below that includes a header:

curl -X GET -H 'Content-type:application/xml'

Or a request in the form below to include a header and form data:

curl -X POST -H "Content-type:application/json" -d \
'{"email" : "", 
  "firstName" : "Jane", 
  "lastName" : "Tutorial", 
  "userName" : "jtutorialxml"
}' \

In both examples, the headers and form data are passed unchanged to the backend service. The headers are represented by flow variables such as request.headers.count and request.headers.names. The form data is represented by flow variables such as request.formparam.count and request.formparam.names.

How is response data returned?

By default, all data received by Edge from the backend service in the response is passed unchanged to the app that originated the request. As described above for the request, the data returned in the response is accessible through flow variables on Edge. See Variables reference for more.

Manipulating request and response data in an API proxy

There are many times where you want to modify request data before sending it to the backend server. For example:

  • To remove security information used by Edge to validate requests. That information is not required by the backend service.
  • To add data sent to the backend service, for example to track users or to gather analytics.
  • To conditionally process the request based on request data. For example, an API proxy can have multiple TargetEndpoints. The TargetEndpoint used by the request is determined by request data. You then strip that data from the request before sending it to the backend service.

The same is true for data in the response. As part of processing the response, the API proxy might want to modify the data before returning it to the requesting app.

Edge defines several policies that you can use to process the request and response data. These policies include:

Learn more

Help or comments?