Send Docs Feedback

Endpoint properties reference

TargetEndpoint Transport Properties

The HTTPTargetConnection element in TargetEndpoint configurations defines a set of HTTP transport properties. You can use these properties to set transport-level configurations.

Properties are set on TargetEndpoint HTTPTargetConnection elements as shown below:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
    <Properties>
      <Property name="supports.http10">true</Property>
      <Property name="request.retain.headers">User-Agent,Referer,Accept-Language</Property>
      <Property name="retain.queryparams">apikey</Property>
    </Properties>
  </HTTPTargetConnection>
</TargetEndpoint>

TargetEndpoint Transport Property Specification

Property Name Default Value Description
keepalive.timeout.millis 60000 Connection idle timeout for the target connection in the connection pool. If the connection in the pool is idle beyond the specified limit, then the connection is closed.
connect.timeout.millis

3000 (cloud)

60000 (on-prem)

 

Target connection timeout. Edge returns an HTTP 503 status code if a connection timeout occurs.

Note that there is a different default  timeout for the cloud and on-premises versions of Edge.

io.timeout.millis 120000

If there is no data to read for the specified number of milliseconds, or if the socket is not ready to write data for specified number of milliseconds, then the transaction is treated as a timeout.

  • If a timeout happens while reading HTTP request, 408, Request Timeout is returned.
  • If a timeout happens while reading HTTP response, 504, Gateway Timeout is returned.

Changes to the default can be discussed by raising a support ticket with Apigee Support

supports.http10 true If this is true and the client sends a 1.0 request, the target is also sent a 1.0 request. Otherwise 1.1 request is sent to target.
supports.http11 true If this is true and the client sends a 1.1 request, the target is also sent a 1.1 request, otherwise 1.0 request is sent to target.
use.proxy true If set to true, and proxy configurations are specified in http.properties (on-premises deployments only), then target connections are set to use the specified proxy.
use.proxy.tunneling true If this is set to true, and proxy configurations are specified in http.properties (on-premises deployments only), then target connections are set to use the specified via tunnel. If the target uses SSL, then this property is ignored, and the message is always sent via a tunnel.
enable.method.override false For the specified HTTP method, sets an X-HTTP-Method-Override header on the outbound request to the target service. For example, <Property name="GET.override.method">POST</Property>
*.override.method N/A For the specified HTTP method, sets an X-HTTP-Method-Override header on the outbound request. For example, <Property name="GET.override.method">POST</Property>
request.streaming.enabled false

By default (false), HTTP request payloads are read into a buffer, and policies that can operate on the payload work as expected. In cases where the payloads are larger than the buffer size (10 MB in Apigee Cloud, 3 MB in Edge for Private Cloud), you can set this attribute to true. When true, HTTP request payloads are not read into a buffer; they are streamed as-is to the target endpoint. In this case, any policies that operate on the payload in the TargetEndpoint request flow are bypassed. See also Streaming requests and responses.

response.streaming.enabled false

By default (false), HTTP response payloads are read into a buffer, and policies that can operate on the payload work as expected. In cases where the payloads are larger than the buffer size (10 MB in Apigee Cloud, 3 MB in Edge for Private Cloud), you can set this attribute to true. When true, HTTP response payloads are not read into a buffer; they are streamed as-is to the ProxyEndpoint response flow. In this case, any policies that operate on the payload in the TargetEndpoint response flow are bypassed. See also Streaming requests and responses.

success.codes N/A

By default, Apigee Edge treats HTTP code 4XX or 5XX as errors, and it treats HTTP code 1XX, 2XX, 3XX as success. This property enables explicit definition of success codes, for example, 2XX, 1XX, 505 treats any 100, 200 and 505 HTTP response codes as success.

Setting this property overwrites the default values. Therefore, if you want to add HTTP code 400 to the list of default success codes, set this property as:

<Property name="success.codes">1xx,2xx,3xx,400</Property>

If you only want HTTP code 400 to be treated as a success code, set the property as:

<Property name="success.codes">400</Property>

compression.algorithm N/A By default, Apigee Edge forwards requests to the target using the same compression type as the client request. If the request is received from client using, for example, gzip compression, then Apigee Edge forwards the request to target using gzip compression. If the response received from target uses deflate, then Apigee Edge forwards the response to the client using deflate. Supported values are:
  • gzip: always send message using gzip compression
  • deflate: always send message using deflate compression
  • none: always send message without any compression

See also: https://community.apigee.com/questions/2027/does-apigee-support-compressionde-compression-with.html

request.retain.headers.
enabled
true By default, Apigee Edge always retains all HTTP headers on outbound messages. When set to true, all HTTP headers present on the inbound request are set on the outbound request.
request.retain.headers N/A Defines specific HTTP headers from the request that should be set on the outbound request to the target service. For example, to 'passthrough' the User-Agent header, set the value of request.retain.headers to User-Agent. Multiple HTTP headers are specified as a comma-separated list, for example, User-Agent,Referer,Accept-Language. This property overrides request.retain.headers.enabled. If request.retain.headers.enabled is set to false, any headers specified in the request.retain.headers property are still set on the outbound message.
response.retain.headers.
enabled
true By default, Apigee Edge always retains all HTTP headers on outbound messages. When set to true, all HTTP headers present on the inbound response from the target service are set on the outbound response before it is passed to the ProxyEndpoint.
response.retain.headers N/A Defines specific HTTP headers from the response that should be set on the outbound response before it is passed to the ProxyEndpoint. For example, to 'passthrough' the Expires header, set the value of response.retain.headers to Expires. Multiple HTTP headers are specified as a comma-separated list, for example, Expires,Set-Cookie. This property overrides response.retain.headers.enabled. If response.retain.headers.enabled is set to false, any headers specified in the response.retain.headers property are still set on the outbound message.
retain.queryparams.
enabled
true By default, Apigee Edge always retains all query parameters on outbound requests. When set to true, all query parameters present on the inbound request are set on the outbound request to the target service.
retain.queryparams N/A Defines specific query parameters to set on the outbound request. For example, to include the query parameter apikey from the request message, set retain.queryparams to apikey. Multiple query parameters are specified as a comma-separated list, for example, apikey,environment. This property overrides retain.queryparams.enabled.

ProxyEndpoint Transport Properties

ProxyEndpoint HTTPTargetConnection elements define a set of HTTP transport properties. These properties can be used to set transport-level configurations.

Properties are set on ProxyEndpoint HTTPProxyConnection elements as follows:

<ProxyEndpoint name="default">
  <HTTPProxyConnection>
    <BasePath>/v1/weather</BasePath>
    <Properties>
      <Property name="allow.http10">true</Property>
      <Property name="request.streaming.enabled">true</Property>
    </Properties>
    <VirtualHost>default</VirtualHost>
    <VirtualHost>secure</VirtualHost>
  </HTTPProxyConnection>
</ProxyEndpoint>

ProxyEndpoint Transport Property Specification

Property Name Default Value Description
allow.http10 true If this is true and the client app sends a 1.0 request, the target is also sent a 1.0 request. If false, then an HTTP 1.1 request is sent to target.
allow.http11 true If this is true and the client app sends a 1.1 request, the target is also sent a 1.1 request. If false, then an HTTP 1.0 request is sent to target.
X-Forwarded-For false When set to true, the virtual host's IP address is added to the outbound request as the value of the HTTP X-Forwarded-For header.
allow.POST.without.
content.length
false When set to false, if the request method is POST and is not chunked, not compressed and the content-length header is missing, then the HTTP response code 411 "Length Required" is returned. When set to true, for the same scenario, the content-length is assumed to be zero, and the request is processed without parsing the payload.
allow.PUT.without.
content.length
false When set to false case : If the request method is PUT and is not chunked, not compressed and the content-length header is missing, then the HTTP response code 411 "Length Required" is returned. When set to true, for the same scenario, the content-length is assumed to be zero, and the request is processed without parsing the payload.
request.streaming.
enabled
false By default (false), HTTP request payloads are read into a buffer, and policies that can operate on the payload work as expected. In cases where the payloads are larger than the buffer size (10 MB in Apigee Cloud, 3 MB in Edge for Private Cloud), you can set this attribute to true. When true, HTTP request payloads are not read into a buffer; they are streamed as-is to the TargetEndpoint request flow. In this case, any policies that operate on the payload in the ProxyEndpoint request flow are bypassed. See also Streaming requests and responses.
response.streaming.
enabled
false By default (false), HTTP response payloads are read into a buffer, and policies that can operate on the payload work as expected. In cases where the payloads are larger than the buffer size (10 MB in Apigee Cloud, 3 MB in Edge for Private Cloud), you can set this attribute to true. When true, HTTP response payloads are not read into a buffer; they are streamed as-is to the client. In this case, any policies that operate on the payload in the ProxyEndpoint response flow are bypassed. See also Streaming requests and responses.
compression.algorithm N/A

By default, Apigee Edge honors the compression type set for any message received. For example, where a client submits a request that uses gzip compression, Apigee Edge forwards the request to target using gzip compression. You can configure compression algorithms to be explicitly applied by setting this property on the TargetEndpoint or ProxyEndpoint. Supported values are:

  • gzip: always send message using gzip compression
  • deflate: always send message using deflate compression
  • none: always send message without any compression

See also: https://community.apigee.com/questions/2027/does-apigee-support-compressionde-compression-with.html

 

Help or comments?