# mulesoft Dropbox Connector - Full Documentation --- product: Dropbox Connector version: 1.0 is-latest-version: true --- # Dropbox Connector 1.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Dropbox (Dropbox Connector) provides access to the Dropbox API. For information about compatibility and fixed issues, refer to the Dropbox Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Dropbox Connector’s API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Studio Before creating an app, you must have: - Credentials to access the Dropbox target resource - Anypoint Platform - Anypoint Studio or Anypoint Code Builder ## Connection Types Dropbox connections use the Oauth 2.0 authentication type, which delegates user authentication to the service hosting the user account. ## Next Step After you complete the prerequisites, you are ready to create an app and configure the connector using Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Dropbox Connector Reference](https://docs.mulesoft.com/dropbox-connector/latest/dropbox-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Dropbox Connector version: 1.0 is-latest-version: true --- # Dropbox Connector 1.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name | String | Name for this configuration. Connectors reference the configuration with this name. | x | |
Connection | Connection types for this configuration. | x | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | 60 | |
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | SECONDS | |
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | AUTO | |
Name | String | ID used to reference this configuration. | x | |
Expiration Policy | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Default Headers | Array of Default Header. | |||
Query Parameters | Array of Default Query Param. | |||
Connection Timeout | Number | How long the connector waits before timing out when establishing a connection to the remote service. | 30 | |
Connection Timeout Unit | Enumeration, one of:
| Time unit for the Connection Timeout field. | SECONDS | |
Use Persistent Connections | Boolean | Indicates whether to use persistent connections: * Mule uses persistent connections. * Mule closes the connection after the first request completes. | true | |
Max Connections | Number | Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput. | -1 | |
Connection Idle Timeout | Number | When persistent connections are enabled, how long a connection can remain idle before Mule closes it. | 30 | |
Connection Idle Timeout Unit | Enumeration, one of:
| Time unit for the Connection Idle Timeout field. | SECONDS | |
Proxy Config | Configures a proxy for outbound connections. | |||
Stream Response | Boolean | If this value is | false | |
Response Buffer Size | Number | Size of the buffer that stores the HTTP response, in bytes. | -1 | |
Token Access Type | String | offline | ||
Protocol | Enumeration, one of:
| Protocol to use for communication. | HTTP | |
TLS Configuration | Configures TLS. If using the HTTPS protocol, you must configure TLS. | |||
Reconnection | What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy: * Allow the deployment to fail. * Ignore the results of the connectivity test. | |||
Consumer Key | String | OAuth consumer key, as registered with the service provider. | x | |
Consumer Secret | String | OAuth consumer secret, as registered with the service provider. | x | |
Authorization Url | String | URL of the service provider’s authorization endpoint. |
| |
Access Token Url | String | URL of the service provider’s access token endpoint. |
| |
Scopes | String | OAuth scopes to request during the OAuth dance. | account_info.write, account_info.read, files.metadata.write, files.metadata.read, files.content.write, files.content.read, sharing.write, sharing.read, file_requests.write, file_requests.read, contacts.write, files.permanent_delete | |
Resource Owner Id | String | Resource owner ID to use with the authorization code grant type. | ||
Before | String | Name of the flow to execute immediately before starting the OAuth dance. | ||
After | String | Name of the flow to execute immediately after receiving an access token. | ||
Listener Config | String | A reference to an | x | |
Callback Path | String | Path of the access token callback endpoint. | x | |
Authorize Path | String | Path of the local HTTP endpoint that triggers the OAuth dance. | x | |
External Callback Url | String | URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL. | ||
Object Store | String | Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Array of Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | #[null] | |
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Array of Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Dropbox API Arg | String | Dropbox API Arg. | x | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | #[null] | |
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | String |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | String | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | * Any * Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Dropbox API Arg | String | Dropbox API Arg. | x | |
Body | String | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Array of Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Body | Any | Content to use. | #[payload] | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | ||
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Resource Owner Id | String | ID of the resource owner for whom to invalidate access. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | #[null] | |
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Custom Query Parameters | Object | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. | #[null] | |
Custom Headers | Object | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. | ||
Response Timeout | Number | How long Mule waits for a response to complete before the request times out. | ||
Response Timeout Unit | Enumeration, one of:
| Time unit for the Response Timeout field. | ||
Streaming Type | Enumeration, one of:
| How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Primary Node Only | Boolean | Determines whether to execute this source on only the primary node when running Mule instances in a cluster. | ||
Scheduling Strategy | scheduling-strategy | Configures the scheduler that triggers the polling. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Redelivery Policy | Defines a policy for processing the redelivery of the same message. | |||
Path | String | Unique ID for the file. | x | |
Recursive | Boolean | If | false | |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Any |
Attributes Type | Object |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Key | String | Key for this type. | x | |
Value | String | Value for this type. | x |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Key | String | Key for this type. | x | |
Value | String | Value for this type. | x |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Host | String | Hostname or IP address of the proxy server. | x | |
Port | Number | Port of the proxy server. | x | |
Username | String | Username to authenticate against the proxy server. | ||
Password | String | Password to authenticate against the proxy server. | ||
Non Proxy Hosts | String | Comma-separated list of hosts that the proxy must not be used against. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Enabled Protocols | String | Comma-separated list of protocols enabled for this context. | ||
Enabled Cipher Suites | String | Comma-separated list of cipher suites enabled for this context. | ||
Trust Store | Configures the TLS truststore. | |||
Key Store | Configures the TLS keystore. | |||
Revocation Check | Configures a revocation checking mechanism. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path | String | Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible. | ||
Password | String | Password used to protect the truststore. | ||
Type | String | Type of truststore. | ||
Algorithm | String | Encryption algorithm that the truststore uses. | ||
Insecure | Boolean | If |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path | String | Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible. | ||
Type | String | Type of keystore. | ||
Alias | String | Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file. | ||
Key Password | String | Password used to protect the private key. | ||
Password | String | Password used to protect the keystore. | ||
Algorithm | String | Encryption algorithm that the keystore uses. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Only End Entities | Boolean | Which elements to verify in the certificate chain:
Verify only the last element in the certificate chain.
Verify all elements in the certificate chain. | ||
Prefer Crls | Boolean | How to check certificate validity:
Check the Certification Revocation List (CRL) for certificate validity.
Use the Online Certificate Status Protocol (OCSP) to check certificate validity. | ||
No Fallback | Boolean | Whether to use the secondary method to check certificate validity:
Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.
Do not use the secondary method to check certificate validity. | ||
Soft Fail | Boolean | What to do if the revocation server can’t be reached or is busy:
Avoid verification failure.
Allow the verification to fail. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Url | String | URL of the OCSP responder. | ||
Cert Alias | String | Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path | String | Path to the CRL file. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Fails Deployment | Boolean | What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:
Allow the deployment to fail.
Ignore the results of the connectivity test. | ||
Reconnection Strategy | Reconnection strategy to use. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency | Number | How often to attempt to reconnect, in milliseconds. | ||
Blocking | Boolean | If | ||
Count | Number | How many reconnection attempts the Mule app can make. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency | Number | How often to attempt to reconnect, in milliseconds. | ||
Blocking | Boolean | If |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Idle Time | Number | Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. | ||
Time Unit | Enumeration, one of:
| Time unit for the Max Idle Time field. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size | Number | Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value. | ||
Buffer Size Increment | Number | Amount by which the buffer size expands if it exceeds its initial size. Setting a value of | ||
Max Buffer Size | Number | The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. | ||
Buffer Unit | Enumeration, one of:
| Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Size | Number | Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:
| ||
Buffer Unit | Enumeration, one of:
| Unit for the In Memory Size field. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Redelivery Count | Number | Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error. | ||
Message Digest Algorithm | String | Secure hashing algorithm to use if the Use Secure Hash field is | ||
Message Identifier | One or more expressions that determine when a message was redelivered. This property can be set only if the Use Secure Hash field is | |||
Object Store | ObjectStore | Configures the object store that stores the redelivery counter for each message. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Use Secure Hash | Boolean | If | ||
Id Expression | String | One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Status Code | Number | HTTP status code of the response. | x | |
Headers | Object | Map of HTTP headers in the message. | x | |
Reason Phrase | String | HTTP reason phrase of the response. | x |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size | Number | Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value. | ||
Buffer Size Increment | Number | Amount by which the buffer size expands if it exceeds its initial size. Setting a value of | ||
Max Buffer Size | Number | The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. | ||
Buffer Unit | Enumeration, one of:
| Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Objects | Number | Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. | ||
Buffer Unit | Enumeration, one of:
| Unit for the In Memory Objects field. |