---
schema_version: "1"
id: f5285c077b3a1b7cc4e122d96d67b7b59b6aecdb05933511f52810afb64a145a
title: Stream Idle Timeout Policy
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/gateway/1.9/policies-included-stream-idle-timeout.md
canonical_url: https://docs.mulesoft.com/gateway/1.9/policies-included-stream-idle-timeout
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 69eb52c569f91c6685eca8efaed1af202348b28efb4c53351f989bb9ea27601c
description: MuleSoft Documentation Site
release: "1.9"
latest: false
---
---
product: Omni Gateway
version: 1.9
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 Flex Gateway version available</strong></p></td><td><p>v1.9.0</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 Flex Gateway or outbound from Flex 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 Flex Gateway API instances have a stream timeout of 300 seconds. Apply the policy to
override the default timeout.

## Configuring Policy Parameters

### Flex Gateway Local Mode

In Local Mode, you apply the policy to your API 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 Flex Gateway closes the connection.</p></div></div></td></tr></tbody></table>

#### Resource Configuration Example

\- policyRef: name: stream-idle-timeout-flex config: timeout: 3

### Managed Flex Gateway and Flex Gateway Connected Mode

When you apply the policy to your API instance 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 Flex Gateway closes the connection.</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr></tbody></table>