Response Timeout Policy
Policy Name |
Response Timeout |
Summary |
Sets the maximum duration that Flex Gateway waits for a response from an upstream service |
Category |
Quality of Service |
First Flex Gateway version available |
v1.9.0 |
Returned Status Codes |
504 - Upstream request timeout |
Summary
The Response Timeout policy enables you to set the maximum duration that Flex Gateway waits for a response from an upstream service. The timeout time starts at the last request sent by Flex Gateway.
By default, all Flex Gateway API instances have a response timeout of 15 seconds. Apply the policy to override the default timeout.
Configuring Policy Parameters
Flex Gateway Local Mode
In Flex Gateway Local Mode, you apply the policy to your API via declarative configuration files. Refer to this policy definition and table of parameters:
- policyRef:
name: response-timeout-flex
config:
timeout: number // REQUIRED
| Parameter | Required or Optional | Default Value | Description |
|---|---|---|---|
|
Required |
15 |
Time in seconds Flex Gateway waits for the response. |
Resource Configuration Example
- policyRef:
name: response-timeout-flex
config:
timeout: 3
Flex Gateway Connected Mode
Applying the policy to your API from the UI shows these parameters:
| Element | Description | Required |
|---|---|---|
Response timeout |
Time in seconds Flex Gateway waits for the response. |
Yes |