---
schema_version: "1"
id: 1d40d178028535ecdcce6c9683d5a6c14e8e0c5879405cf5f5d7961ba713fdbb
title: Stream Idle Timeout Policy
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/gateway/latest/policies-included-stream-idle-timeout.md
canonical_url: https://docs.mulesoft.com/gateway/latest/policies-included-stream-idle-timeout
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 2aca65d423cd7fb085c87e9722eb0f1b0b03a2869d131e74814bb025af352eb7
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
---

# Stream 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 duration a stream can remain idle without receiving a request or response</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/stream-idle-timeout-release-notes">Stream Idle Timeout</a></p></td></tr><tr><td><p><strong>Returned Status Codes</strong></p></td><td><p>504 - Stream timeout</p></td></tr></tbody></table>

## Summary

The Stream Idle Timeout policy sets a maximum duration for which a stream can remain idle without
receiving any data, either inbound from the client to Omni Gateway or outbound from Omni Gateway to
the upstream service. The policy prevents idle connections from consuming resources unnecessarily.
The timeout period starts at the last activity on the stream, whether the activity is a request or a
response.

By default, all Omni Gateway API instances have a stream timeout of 300 seconds. Apply the policy to
override the default timeout.

This policy overrides every other Stream 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: stream-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>300</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: stream-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>Stream 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>