---
schema_version: "1"
id: b7622da8149d78219df943acb57c9b8225fbc8281a8cf3f9effaaf5be4624bdf
title: Upstream Idle Timeout Policy
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/gateway/latest/policies-outbound-upstream-idle-timeout.md
canonical_url: https://docs.mulesoft.com/gateway/latest/policies-outbound-upstream-idle-timeout
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 702b6802915e72ea62866462e1a7f9ebeb91a3fa3e72c9a6d5874df393e007f6
description: MuleSoft Documentation Site
release: "1.14"
latest: true
---
---
product: Omni Gateway
version: 1.14
is-latest-version: true
keywords: basic authentication, api gateway, flex gateway, gateway, policy
---

# Upstream Idle Timeout Policy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Policy Name</strong></p></td><td><p>Stream Idle Timeout</p></td></tr><tr><td><p><strong>Summary</strong></p></td><td><p>Sets the maximum idle duration for a stream between the Omni Gateway and an upstream service</p></td></tr><tr><td><p><strong>Category</strong></p></td><td><p>Quality of Service</p></td></tr><tr><td><p><strong>First Omni Gateway version available</strong></p></td><td><p>v1.9.0</p></td></tr><tr><td><p><strong>Release Notes</strong></p></td><td><p><a href="https://docs.mulesoft.com/release-notes/gateway/policies/outbound-upstream-idle-timeout-release-notes">Stream Idle Timeout</a></p></td></tr><tr><td><p><strong>Returned Status Codes</strong></p></td><td><p>504 - Upstream request timeout</p></td></tr></tbody></table>

## Summary

The Upstream Idle Timeout policy lets you set a maximum idle duration between requests for a stream
between Omni Gateway and the upstream service. By applying the policy, you prevent idle connections
from consuming resources while simultaneously allowing persistent connections to remain open. The
timeout starts at the last request.

By default, all Omni Gateway API instances have an upstream idle timeout of 60 seconds. Apply the
policy to override the default timeout.

This policy overrides every other Upstream Connection Idle 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](https://docs.mulesoft.com/gateway/latest/managed-timeout) or
[Configuring Timeouts in Connected Mode](https://docs.mulesoft.com/gateway/latest/conn-timeout).

## 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: idle-timeout-flex config: timeout: number // REQUIRED

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Required or Optional</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>timeout</code></p></div></div></td><td><div><div><p>Required</p></div></div></td><td><div><div><p>60</p></div></div></td><td><div><div><p>Time in seconds before Omni Gateway closes the connection.</p></div></div></td></tr></tbody></table>

#### Resource Configuration Example

\- policyRef: name: idle-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:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Element</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p>Upstream idle timeout</p></div></div></td><td><div><div><p>Time in seconds before Omni Gateway closes the connection.</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr></tbody></table>