---
schema_version: "1"
id: 1bcb7301511e190d43dcb97294f13a938fa078996df8fbb8d67f3b62542a18fd
title: Upstream Idle Timeout Policy
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/gateway/1.13/policies-outbound-upstream-idle-timeout.md
canonical_url: https://docs.mulesoft.com/gateway/1.13/policies-outbound-upstream-idle-timeout
source_site: docs.mulesoft.com
content_type: documentation
content_hash: f6175c6a6030e16eb3cf8557bc7cc39de8b3a47d8a4ac8b28a4611351287461c
description: MuleSoft Documentation Site
release: "1.13"
latest: false
---
---
product: Omni Gateway
version: 1.13
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.

## 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>