---
schema_version: "1"
id: 894309cbadaaa3bb6d45636ad7234bc413c2184c5ab7e7c9f689ebba30a2dba4
title: HTTP Connector 1.10 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/http-connector/1.10/http-documentation.md
canonical_url: https://docs.mulesoft.com/http-connector/1.10/http-documentation
source_site: docs.mulesoft.com
content_type: documentation
content_hash: d3065d6e18d19c5775eb3aea04e3afe4a57d61f4772c7c558366ab5d157c056a
description: MuleSoft Documentation Site
release: "1.10"
latest: false
---
---
product: HTTP Connector
version: 1.10
---

# HTTP Connector 1.10 Reference

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

Use Anypoint Connector for HTTP (HTTP Connector) to handle and perform HTTP requests. This class
only serves as an extension definition. This connector’s configurations are divided between a server
(`<http:listener-config>`) and a client (`<http:requester-config>`). capabilities.

Release Notes: [HTTP Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/connector-http)

## Configurations

---

### Listener Configuration

Configuration element for a HttpListener.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p><a href="#listenerConfig_listener">Listener</a></p></div></div></td><td><div><div><p>The connection types that can be provided to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Base Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Base path to use for all requests that reference this config.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Listener Interceptors</strong></p></td><td><div><div><p><a href="#CorsInterceptorWrapper">CORS Interceptor Wrapper</a></p></div></div></td><td><div><div><p>Listener interceptors that will apply on request and on response events.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reject Invalid Transfer Encoding</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, requests with an invalid value for Transfer-Encoding header are rejected with a 400 Bad Request message. The valid values are <code>chunked</code>, <code>deflate</code>, <code>compress</code>, <code>identity</code> and <code>gzip</code>. These values are defined in <code>RFC-7230</code> and <code>RFC-2616</code>.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

#### Connection Types

##### Listener

Connection provider for a HttpListener, handles the creation of HttpServer instances.

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><div><div><p>Reference to a TLS config element. This will enable HTTPS for this config.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Protocol</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HTTP</p></li><li><p>HTTPS</p></li></ul></div></div></td><td><div><div><p>Protocol to use for communication. Valid values are HTTP and HTTPS. Default value is HTTP. When using HTTPS the HTTP communication is going to be secured using TLS / SSL. If HTTPS was configured as protocol then the user needs to configure at least the keystore in the tls:context child element of this listener-config.</p></div></div></td><td><div><div><p>HTTP</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Host where the requests will be sent.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port where the requests will be received.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Use Persistent Connections</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, each connection will be closed after the first request is completed.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Idle Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of milliseconds that a connection can remain idle before it is closed. The value of this attribute is only used when persistent connections are enabled. The listener default connection Idle timeout is bigger than the requester connection Idle default timeout to avoid the Remotely closed exception when you send a request on an existing connection just before the timeout occurs.</p></div></div></td><td><div><div><p>40000</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum time in milliseconds that the listener must wait while receiving a message.</p></div></div></td><td><div><div><p>30000</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Associated Sources

- [Listener](#listener)

- [Polling Source](#pollingSource)

---

### Request Configuration

Configuration element for a HTTP requests.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p><a href="#requestConfig_request">Request</a></p></div></div></td><td><div><div><p>The connection types that can be provided to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Base Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Base path to use for all requests that reference this config.</p></div></div></td><td><div><div><p>/</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Follow Redirects</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to follow redirects or not. Default value is true.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Send Body Mode</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS</p></li><li><p>AUTO</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>Defines if the request should contain a body or not. If AUTO, it will depend on the method (GET, HEAD and OPTIONS will not send a body).</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Request Streaming Mode</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>Defines if the request should be sent using streaming or not. If this attribute is not present, the behavior will depend on the type of the payload (it will stream only for InputStream). If set to true, it will always stream. If set to false, it will never stream. As streaming is done the request will be sent user Transfer-Encoding: chunked.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable Cookies</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If true, cookies received in HTTP responses are stored and sent in subsequent HTTP requests.</p></div><div><p>When an <code>http:request-config</code> element has cookies enabled, a single <code>CookieManager</code> is created for each instance of the <code>request-config</code>. If multiple <code>http:request</code> elements in a Mule application reference the same <code>http:request-config</code>, they all share the same <code>CookieManager</code> instance.</p></div><div><p>If you have a dynamic configuration, a new <code>http:request-config</code> instance is created for each parameterization. Therefore, each parameterization has its own <code>CookieManager</code> instance. For details, see <a href="https://docs.mulesoft.com/mule-sdk/latest/static-dynamic-configs#dynamic-configuration-lifecycle">Dynamic Configuration Lifecycle</a>.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Default Headers</strong></p></td><td><div><div><p>Array of <a href="#defaultHeader">Default Header</a></p></div></div></td><td><div><div><p>Default HTTP headers the message should include.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Parameters</strong></p></td><td><div><div><p>Array of <a href="#QueryParam">Query Param</a></p></div></div></td><td><div><div><p>Default Query parameters the request should include.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Send Correlation Id</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>Whether to specify a correlation id when publishing messages. This applies both for custom correlation ids specified at the operation level and for default correlation ids taken from the current event.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Preserve Headers Case</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>By default, header keys are stored internally in lower-case. This is to improve performance of headers handling and is functionally correct as specified in the RFC. &lt;p&gt; In the case a server expects headers in a specific case, this flag may be set to true so the case of the header keys are preserved.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Response Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum time in milliseconds that the request element blocks the execution of the flow waiting for the HTTP response. If this value isn’t set, the connector uses the <code>defaultResponseTimeout</code> value configured in the <a href="https://docs.mulesoft.com/mule-runtime/latest/global-settings-configuration#global-configurations-reference">Mule global configuration</a>. If no global value is configured, the default is 10000 milliseconds.</p></div></div></td><td><div><div><p>Inherited from <code>defaultResponseTimeout</code> (10000 ms by default)</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Response Validator</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#SuccessStatusCodeValidator">Success Status Code Validator</a></p></li><li><p><a href="#FailureStatusCodeValidator">Failure Status Code Validator</a></p></li></ul></div></div></td><td><div><div><p>Configures a default error handling of the response.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Connection Types

##### Request

Connection provider for a HTTP request, handles the creation of HttpExtensionClient instances.

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Proxy Config</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#proxy">Proxy</a></p></li><li><p><a href="#ntlm-proxy">NTLM Proxy</a></p></li></ul></div></div></td><td><div><div><p>Reusable configuration element for outbound connections through a proxy. A proxy element must define a host name and a port attributes, and optionally can define a username and a password.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Authentication</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#BasicAuthentication">Basic Authentication</a></p></li><li><p><a href="#DigestAuthentication">Digest Authentication</a></p></li><li><p><a href="#NtlmAuthentication">NTLM Authentication</a></p></li><li><p><a href="https://docs.mulesoft.com/oauth-module/latest/oauth-module-reference#authorization-code-grant-type">OAuth2 Authorization Code Grant Type Authentication</a></p></li><li><p><a href="https://docs.mulesoft.com/oauth-module/latest/oauth-module-reference#ClientCredentialsGrantType">OAuth2 Client Credentials Grant Type Authentication</a></p></li></ul></div></div></td><td><div><div><p>Authentication method to use for the HTTP request.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><div><div><p>Reference to a TLS config element. This will enable HTTPS for this config.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Protocol</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HTTP</p></li><li><p>HTTPS</p></li></ul></div></div></td><td><div><div><p>Protocol to use for communication. Valid values are HTTP and HTTPS. Default value is HTTP. When using HTTPS the HTTP communication is going to be secured using TLS/SSL. If HTTPS was configured as protocol, then the user can customize the TLS/SSL configuration by defining the <code>tls:context</code> child element of this listener-config. If not <code>tls:context</code> is defined, then the default JVM certificates are used to establish communication.</p></div></div></td><td><div><div><p>HTTP</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Host where the requests will be sent.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port where the requests will be sent. If the protocol attribute is HTTP (default) then the default value is 80, if the protocol attribute is HTTPS then the default value is 443.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Use Persistent Connections</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, each connection will be closed after the first request is completed.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of outbound connections that will be kept open at the same time. By default the number of connections is unlimited. Setting a value for max connections helps limit memory usage, although it may reduce throughput.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Idle Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of milliseconds that a connection can remain idle before it is closed. The value of this attribute is only used when persistent connections are enabled.</p></div></div></td><td><div><div><p>30000</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Stream Response</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether or not received responses should be streamed, meaning processing will continue as soon as all headers are parsed and the body streamed as it arrives. When enabled, the response MUST be eventually read since depending on the configured buffer size it may not fit into memory and processing will stop until space is available.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Response Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The space in bytes for the buffer where the HTTP response will be stored.</p></div></div></td><td><div><div><p>1024</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Socket Properties</strong></p></td><td><div><div><p><a href="#TcpClientSocketProperties">TCP Client Socket Properties</a></p></div></div></td><td><div><div><p>Configures the client socket properties.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Associated Operations

- [Request](#request)

## Operations

### Request

`<http:request>`

Consumes an HTTP service.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Method</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The HTTP method for the request.</p></div></div></td><td><div><div><p>GET</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams should be used and their behavior</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path where the request will be sent.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL where to send the request.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Follow Redirects</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to follow redirects or not.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Send Body Mode</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS</p></li><li><p>AUTO</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>Defines if the request should contain a body or not.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Request Streaming Mode</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>Defines if the request should be sent using streaming or not.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Response Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum time in milliseconds that the request element will block the execution of the flow waiting for the HTTP response.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Body</strong></p></td><td><div><div><p>Any</p></div></div></td><td><div><div><p>The body of the response message</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Headers</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>HTTP headers the message should include.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>URI Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>URI parameters that should be used to create the request.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Query parameters the request should include.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Send Correlation Id</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>Options on whether to include an outbound correlation ID or not</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Correlation Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Allows you to set a custom correlation ID.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Response Validator</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#SuccessStatusCodeValidator">Success Status Code Validator</a></p></li><li><p><a href="#FailureStatusCodeValidator">Failure Status Code Validator</a></p></li></ul></div></div></td><td><div><div><p>Configures error handling of the response.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable on which the operation’s output will be placed</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors. This field is not used by this operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

#### For Configurations.

- [Request Configuration](#requestConfig)

#### Throws

- HTTP:BAD\_REQUEST

- HTTP:CLIENT\_SECURITY

- HTTP:CONNECTIVITY

- HTTP:FORBIDDEN

- HTTP:INTERNAL\_SERVER\_ERROR

- HTTP:METHOD\_NOT\_ALLOWED

- HTTP:NOT\_ACCEPTABLE

- HTTP:NOT\_FOUND

- HTTP:PARSING

- HTTP:RETRY\_EXHAUSTED

- HTTP:SECURITY

- HTTP:SERVICE\_UNAVAILABLE

- HTTP:TIMEOUT

- HTTP:TOO\_MANY\_REQUESTS

- HTTP:UNAUTHORIZED

- HTTP:UNSUPPORTED\_MEDIA\_TYPE

- HTTP:BAD\_GATEWAY

- HTTP:GATEWAY\_TIMEOUT

### Basic Security Filter

`<http:basic-security-filter>`

Authenticates received HTTP requests. Must be used after a listener component.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Realm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Authentication realm.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Security Providers</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>The delegate-security-provider to use for authenticating. Use this in case you have multiple security managers defined in your configuration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Attributes</strong></p></td><td><div><div><p><a href="#HttpRequestAttributes">HTTP Request Attributes</a></p></div></div></td><td><div><div><p>The HttpRequestAttributes coming from an HTTP listener source to check the <code>Authorization</code> header.</p></div></div></td><td><div><div><p>#[attributes]</p></div></div></td><td><div></div></td></tr></tbody></table>

#### Throws

- HTTP:BASIC\_AUTHENTICATION

- MULE:SERVER\_SECURITY

### Load Static Resource

`<http:load-static-resource>`

The static resource serves static content to use with HTTP. The request path is used to look up the
resource.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Resource Base Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The resource base from where documents are served up. For example: /Users/maxthemule/resources</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Default File</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The default file to serve when a directory is specified. The default value is <code>index.html</code>.</p></div></div></td><td><div><div><p>index.html</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Attributes</strong></p></td><td><div><div><p><a href="#HttpRequestAttributes">HTTP Request Attributes</a></p></div></div></td><td><div><div><p>The HttpRequestAttributes coming from an HTTP listener source to check the required resources.</p></div></div></td><td><div><div><p>#[attributes]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable on which the operation’s output will be placed</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

#### Throws

- HTTP:NOT\_FOUND

## Sources

### Listener

`<http:listener>`

Represents a listener for HTTP requests.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Relative path from the path set in the HTTP Listener configuration</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Allowed Methods</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of allowed HTTP methods by this listener. To allow all methods do not define the attribute.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Response Streaming Mode</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>Defines if the response should be sent using streaming or not. If this attribute is not present, the behavior will depend on the type of the payload (it will stream only for InputStream). If set to true, it will always stream. If set to false, it will never stream. As streaming is done the response will be sent user Transfer-Encoding: chunked.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Primary Node Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether this source should only be executed on the primary node when running in Cluster</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams should be used and their behavior</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Redelivery Policy</strong></p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Body</strong></p></td><td><div><div><p>Any</p></div></div></td><td><div><div><p>The body of the response message.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Headers</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>HTTP headers the message should include.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status Code</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>HTTP status code the response should have.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reason Phrase</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>HTTP reason phrase the response should have.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpRequestAttributes">HTTP Request Attributes</a></p></div></div></td></tr></tbody></table>

#### For Configurations.

- [Listener Configuration](#listenerConfig)

### Polling Source

`<http:polling-source>` Event source that executes a scheduled HTTP request to a given HTTP server.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Relative path from the path set in the HTTP Request operation configuration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Method</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>HTTP request method</p></div></div></td><td><div><div><p>GET</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Response Validator</strong></p></td><td><div><div><p>One of: * <a href="#SuccessStatusCodeValidator">Success Status Code Validator</a> * <a href="#FailureStatusCodeValidator">Failure Status Code Validator</a> * ExpressionResponseValidator</p></div></div></td><td><div><div><p>Validation applied to the connectivity test response.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Primary Node Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether to execute this source only on the primary node when running Mule instances in a cluster.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>On Capacity Overload</strong></p></td><td><div><div><p>Enumeration, one of: <strong>DROP </strong>WAIT ** FAIL</p></div></div></td><td><div><div><p>Strategy that Mule applies when the flow receives more messages than it has the capacity to manage.</p></div></div></td><td><div><div><p>WAIT</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Scheduling Strategy</strong></p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><div><div><p>Configures the scheduler that triggers the polling.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Redelivery Policy</strong></p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Body</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Body of the response message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Headers</strong></p></td><td><div><div><p>Array of pollingRequestHeader</p></div></div></td><td><div><div><p>HTTP headers the message includes.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>URI Parameters</strong></p></td><td><div><div><p>Array of pollingRequestUriParam</p></div></div></td><td><div><div><p>URI parameters used to create the request.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Parameters</strong></p></td><td><div><div><p>Array of pollingRequestQueryParam</p></div></div></td><td><div><div><p>Query parameters the request includes.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Split Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The split expression to apply to the response.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Watermark Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The expression to retrieve the watermark from the (split) response.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The expression to retrieve the ID from every (split) item.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Request Configuration](#requestConfig)

## Types

### TLS

Reference to a TLS config element, which enables HTTPS for the configuration.

> [!NOTE] Starting with Mule runtime 4.10, configure keystore and truststore paths relative to the
> classpath or file system. Absolute paths throw
> `KeyStore must be configured for server side SSL in configuration` unless you set
> `mule.tlsStores.filesystemLookup.enable` to `true`. For more information, see
> [Configure TLS with Keystores and Truststores](https://docs.mulesoft.com/mule-runtime/latest/tls-configuration).

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma separated list of cipher suites enabled for this context. Use IANA (Internet Assigned Numbers Authority) naming convention for the cipher suites. Check the <a href="https://testssl.sh/openssl-iana.mapping.html">OpenSSL - IANA mapping</a> for reference. Additionally, review <a href="https://docs.mulesoft.com/mule-runtime/latest/tls-configuration#example-adding-additional-cipher-suites-and-protocol-restrictions">TLS Configuration Examples</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td><div><div><p>Configures the truststore for TLS.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td><div><div><p>Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#standard-revocation-check">Standard Revocation Check</a></p></li><li><p><a href="#custom-ocsp-responder">Custom OCSP Responder</a></p></li><li><p><a href="#crl-file">CRL File</a></p></li></ul></div></div></td><td><div><div><p>Configures a revocation check for TLS.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store

Configures the truststore for TLS.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a
public certificate.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which resolves relative to the current classpath and file system, if possible) of the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file is used by default.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Only verify the last element of the certificate chain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Try CRL instead of OCSP first.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Do not use the secondary checking method (the one not selected before).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response (must be in the trust store), if present.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### CRL File

Specifies the location of the certification revocation list (CRL) file.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>The reconnection strategy to use</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>How often in milliseconds to reconnect.</p></td><td></td><td></td></tr><tr><td><p>Count</p></td><td><div><div><p>Number</p></div></div></td><td><p>How many reconnection attempts to make.</p></td><td></td><td></td></tr><tr><td><p>blocking</p></td><td><p>Boolean</p></td><td><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></td><td><p>true</p></td><td></td></tr></tbody></table>

### Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to
reconnect at a specified frequency for as long as the Mule app runs.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>How often in milliseconds to reconnect.</p></td><td></td><td></td></tr><tr><td><p>blocking</p></td><td><p>Boolean</p></td><td><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></td><td><p>true</p></td><td></td></tr></tbody></table>

### CORS Interceptor Wrapper

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Cors Interceptor</strong></p></td><td><div><div><p><a href="#CorsListenerInterceptor">CORS Listener Interceptor</a></p></div></div></td><td><div><div><p>Interceptor which validates that requests match CORS specification and acts on responses accordingly.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### CORS Listener Interceptor

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Allow Credentials</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Origins</strong></p></td><td><div><div><p>Array of One of:</p></div><div><ul><li><p>public-resource</p></li><li><p><a href="#origin">Origin</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### HTTP Request Attributes

To get familiar on how to use message attributes, refer to the
[about message attributes](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message) documentation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Listener Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Full path where the request was received.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Raw Request Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Full path requested, encoded as received. @since 1.5.0</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Relative Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path where the request was received, without considering the base path.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Masked Request Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path computed from masking the listenerPath and taking the difference. Note that this is only calculated when the null otherwise.</p></div><div><div><pre>@since 1.4.0</pre></div></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>HTTP version of the request.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Scheme</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>HTTP scheme of the request.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Method</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>HTTP method of the request.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Request Uri</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Full URI of the request.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Raw Request Uri</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Full URI of the request, encoded as received. @since 1.5.0</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Query String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Query string of the request.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Local Address</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Local host address from the server.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Remote Address</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Remote host address from the sender.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Client Certificate</strong></p></td><td><div><div><p>Any</p></div></div></td><td><div><div><p>Client certificate (if 2 way TLS is enabled).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Params</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Query parameters map built from the parsed string.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Uri Params</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>URI parameters extracted from the request path.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Request Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Full path requested.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Headers</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map of HTTP headers in the message.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX
buffer size. Always run performance tests to find the optimal buffer size for your specific use
case.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is the amount of memory allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is the maximum amount of memory that the buffer can use. If the buffer uses more than that, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means there’s no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which all these attributes are expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream
content in memory. If the stream content is larger than the configured buffer size, Mule backs up
the buffer’s content to disk and then clears the memory.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Defines the maximum memory that the stream can use to keep data in memory. If more than that is consumed, the content is buffered on disk.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a
redelivery policy to any source in a flow.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Redelivery Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Use Secure Hash</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use a secure hash algorithm to identify a redelivered message</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Digest Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The secure hashing algorithm to use. If not set, the default is SHA-256.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>ObjectStore</p></div></div></td><td><div><div><p>The object store where the redelivery counter for each message is stored.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### TCP Client Socket Properties

Configures the client socket properties.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Time to wait during a connection to a remote server before failing with a timeout. If the configured requester host resolves to multiple IP addresses, the host tries to connect to every single IP address. Therefore, if every connection times out, the number of resolved IP addresses multiplies the global connection timeout.</p></div></div></td><td><div><div><p>30000</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Send Tcp No Delay</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether or not to collect the transmitted data for greater efficiency and send the data immediately.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Linger</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long, in milliseconds, the socket takes to close, so any remaining data is transmitted correctly.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Keep Alive</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether the open socket connections unused for a long period and with an unavailable connection can be closed.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fail On Unresolved Host</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether the socket fails during its creation if the host set on the endpoint cannot be resolved.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Send Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Size of the buffer, in bytes, when sending data.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Receive Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Size of the buffer, in bytes, when receiving data.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Time, in milliseconds, that the socket waits in a blocking operation before failing.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reuse Address</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When trying to bind the port, indicates whether to reuse (<code>true</code>) or fail (<code>false</code>) the configured port.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before
Mule considers it eligible for expiration. This does not mean that the instance expires at the exact
moment that it becomes eligible. Mule purges the instances as appropriate.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the maxIdleTime attribute</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Default Header

Default HTTP headers the message should include.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Key for default HTTP headers.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Value for default HTTP headers.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Query Param

Default query parameters the request should include.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Key name for default query parameter.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Value for default query parameter.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### HTTP Response Attributes

To get familiar on how to use message attributes, refer to the
[about message attributes](https://docs.mulesoft.com/mule-runtime/latest/about-mule-message) documentation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Status Code</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>HTTP status code of the response.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reason Phrase</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>HTTP reason phrase of the response.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Headers</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map of HTTP headers in the message.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Basic Authentication

The basic authentication method enables an HTTP user agent to provide a username and password when
making an HTTP request.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The username to authenticate.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password to authenticate.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Preemptive</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Configures if authentication should be preemptive or not. Preemptive authentication will send the authentication header in the first request, instead of waiting for a 401 response code to send it.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Digest Authentication

The digest authentication method enables a web server to verify user credentials via the user’s web
browser.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The username to authenticate.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password to authenticate.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Preemptive</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Configures if authentication should be preemptive or not. Preemptive authentication will send the authentication header in the first request, instead of waiting for a 401 response code to send it.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### NTLM Authentication

NT LAN Manager (NTLM) authentication replaces the authentication protocol in Microsoft LAN Manager
(LANMAN), an older Microsoft product.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The domain to authenticate.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Workstation</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The workstation to authenticate.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The username to authenticate.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password to authenticate.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Preemptive</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Configures if authentication should be preemptive or not. Preemptive authentication will send the authentication header in the first request, instead of waiting for a 401 response code to send it.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Proxy

Reusable configuration element for outbound connections through a proxy. A proxy element must define
a host name and a port attributes, and optionally can define a username and a password.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Host where the proxy requests will be sent.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port where the proxy requests will be sent.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The username to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A list of comma separated hosts against which the proxy is not used</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### NTLM Proxy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Ntlm Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The domain to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Host where the proxy requests will be sent.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port where the proxy requests will be sent.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The username to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A list of comma separated hosts against which the proxy is not used</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Success Status Code Validator

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Values</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Status codes that are considered.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Failure Status Code Validator

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Values</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Status codes that are considered.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Origin

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the Origins, from which the browser can load resources.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Access Control Max Age</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of time, in seconds, to cache the results of a preflight request.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Allowed Methods</strong></p></td><td><div><div><p>Array of <a href="#Method">Method</a></p></div></div></td><td><div><div><p>Indicates which HTTP methods are permitted while accessing the resources from the origin.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Allowed Headers</strong></p></td><td><div><div><p>Array of <a href="#Header">Header</a></p></div></div></td><td><div><div><p>In preflight requests, indicates the HTTP headers to use during the actual request.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Expose Headers</strong></p></td><td><div><div><p>Array of <a href="#Header">Header</a></p></div></div></td><td><div><div><p>Response headers exposed in the request.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Method

HTTP method name.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Method Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>HTTP method name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Header

HTTP header name.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Header Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>HTTP header name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)