Contact Us 1-800-596-4880
  1. Homepage
  2. Omni Gateway (1.14)
  3. Securing Omni Gateway Instances with Policies
  4. Inbound Policies Directory

  5. Response Timeout

Response Timeout Policy

Policy Name

Response Timeout

Summary

Sets the maximum duration that Omni Gateway waits for a response from an upstream service

Category

Quality of Service

First Omni Gateway version available

v1.9.0

Release Notes

Response Timeout

Returned Status Codes

504 - Upstream request timeout

Summary

The Response Timeout policy sets how long Omni Gateway waits for a response from an upstream service before it returns a 504 error. The timer starts when Omni Gateway sends the request to the upstream service.

Without this policy, an API instance uses the gateway-level Upstream Response Timeout. The gateway-level default is 15 seconds.

This policy overrides every other Upstream Response Timeout configuration for the API instance you apply it to, whether the policy value is higher or lower. To change the gateway-level timeout, see Configure Timeouts for Managed Omni Gateway or Configuring Timeouts in Connected Mode.

Configuring Policy Parameters

Omni Gateway Local Mode

When you apply the policy via declarative configuration files, Refer to the following policy definition and table of parameters:

- policyRef:
    name: response-timeout-flex
  config:
    timeout: number // REQUIRED
Parameter Required or Optional Default Value Description

timeout

Required

15

Number of seconds Omni Gateway waits for a response from the upstream service.

Resource Configuration Example

- policyRef:
    name: response-timeout-flex
  config:
    timeout: 3

Managed Omni Gateway and Omni Gateway Connected Mode

When you apply the policy from the UI, the following parameters are displayed:

Element Description Required

Response timeout

Number of seconds Omni Gateway waits for a response from the upstream service.

Yes