How long the connector waits before timing out when establishing a connection to the remote service.
30
Connection Timeout Unit
Enumeration, one of:
NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS
Time unit for the Connection Timeout field.
SECONDS
Use Persistent Connections
Boolean
Indicates whether to use persistent connections: true: Mule uses persistent connections. false: Mule closes the connection after the first request completes.
true
Max Connections
Number
Maximum number of outbound connections to keep open at the same time.
-1
Connection Idle Timeout
Number
How long the connector waits before timing out when establishing a connection to the remote service.
30
Connection Idle Timeout Unit
Enumeration, one of:
NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS
Time unit for the Connection Timeout field.
SECONDS
Proxy Config
Proxy
Configures a proxy for outbound connections.
Stream Response
Boolean
If this value is true, Mule streams received responses.
false
Response Buffer Size
Number
Size of the buffer that stores the HTTP response, in bytes.
-1
Protocol
Enumeration, one of:
HTTP
HTTPS
Protocol to use for communication.
HTTP
TLS Configuration
TLS
Configures TLS. If using the HTTPS protocol, you must configure TLS.
Configures a reconnection strategy to use when a connector operation fails to connect to an external server.
Supported Operations
Get all projects
Fetches all the projects for a particular team, this makes a HTTP GET request to /projects.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Target Variable
String
The name of a variable on which the operation’s output will be placed.
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.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Create a project within a folder. You need to specify the name of the project and the folderId of the folder where the project will be created, this makes a HTTP POST request to /projects.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Body
any
Properties to create project with.
#[payload]
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Fetch a specific project by Id, this makes a HTTP GET request to /projects/[projectId].
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Project Id
String
Unique identifier (id) for a specific project.
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Archive or Unarchive project by id, this makes a HTTP PUT request to /projects/[projectId]/isArchived.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Body
any
Action property to perform on object.
#[payload]
x
Project Id
String
Unique identifier (id) for a specific project.
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Fetch all files for the specified project, this makes a HTTP GET request to /projects/[projectId]/files.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Project Id
String
Unique identifier (id) for a specific project.
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Fetch all versions of the specified file, this makes a HTTP GET request to /files/[fileId]/versions.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
File Id
String
Unique identifier (id) for a specific file.
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Generates a presigned S3 URL (uploadURL) to directly upload a file and a fileURL to use the uploaded file with POST /files endpoint. This makes a HTTP POST request to /files/upload-url.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Body
any
Properties to use.
#[payload]
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Remove a specific file by id, this makes a HTTP DELETE request to /files/[fileId].
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
File Id
String
Unique identifier (id) for a specific file.
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Move a file to another review step, this makes a HTTP POST request to /files/[fileId]/move-to-step.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
File Id
String
Unique identifier (id) for a specific file.
x
Body
any
Properties to use.
#[payload]
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Download the contents of the original file that was uploaded to Filestage, this makes a HTTP GET request to /versions/[versionId]/contents.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Version Id
String
Unique identifier (id) for a specific version.
x
Referer
String
To be able to download from our servers you need to set the Referer.
https://api.filestage.io
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Download the review report of the file (Image & Document file types only) that was reviewed on Filestage, this makes a HTTP GET request to /versions[versionId]/report.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Version Id
String
Unique identifier (id) for a specific version.
x
Referer
String
To be able to download from our servers you need to set the Referer.
https://api.filestage.io
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Approve or revoke specified file, this makes a HTTP PUT request to /files/[fileId]/isApproved.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
File Id
String
Unique identifier (id) for a specific file.
x
Body
any
Properties to use.
#[payload]
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
You need to specify the URL (https) of the website and because this operation can potentially take a long time we also need you to provide a callback URL so we can notify you when the import has been completed. If you provide a file id then a new version will be created for the existing file. This makes a HTTP POST request to /files/import-website.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Body
any
Properties to use.
#[payload]
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Upload a file to a review step. You need to specify the URL from which we download the file to our server. Because this operation can potentially take a long time we also need you to provide a callback URL so we can notify you when the file has been uploaded. If you provide a file id then a new version will be created for the existing file. This makes a HTTP POST request to /files.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Body
any
Properties to use.
#[payload]
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Fetch a specific file by Id, this makes a HTTP GET request to /files/[fileId].
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
File Id
String
Unique identifier (id) for a specific file.
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Fetch a specific file by Id, this makes a HTTP GET request to /versions/[versionId].
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Version Id
String
Unique identifier (id) for a specific version.
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Create a comment reply. You need to specify the body of the comment and specify if it is team only or not. This makes a HTTP POST request to /comments/[commentId]/replies.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Comment Id
String
Unique identifier (id) for a specific comment.
x
Body
any
Properties to use.
#[payload]
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Create a general commment for a version. You need to specify the body of the comment and specify if it is team only or not. This makes a HTTP POST request to /versions/[versionId]/comments.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Version Id
String
Unique identifier (id) for a specific version.
x
Body
any
Properties to use.
#[payload]
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Fetch all comments for the specified file version. This makes a HTTP GET request to /versions/[versionId]/comments.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Version Id
String
Unique identifier (id) for a specific version.
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Add reviewers to a specific step. This makes a HTTP POST request to /steps/[stepId]/reviewers.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Step Id
String
Unique identifier (id) for a specific step.
x
Body
any
Properties to use.
#[payload]
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Fetch all review steps for a specific project. This makes a HTTP GET request to /projects/[projectId]/steps.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Project Id
String
Unique identifier (id) for a specific project.
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Create a review step within a project. Optionally, you can invite reviewers directly to the new review step. This makes a HTTP POST request to /steps.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Body
any
Properties to use.
#[payload]
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Fetches all the folders for the team. This makes a HTTP GET request to /folders.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Create a folder, you need to specify the name of the folder. This makes a HTTP POST request to /folders.
Parameters
Name
Type
Description
Default Value
Required
Configuration
String
Name of the configuration to use.
x
Body
any
Properties to use.
#[payload]
x
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.
Target Variable
String
The name of a variable on which the operation’s output will be placed.
Target Value
String
An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.
Configures a reconnection strategy for an operation.
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: true: Allow the deployment to fail. false: Ignore the results of the connectivity test.
Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
Field
Type
Description
Default Value
Required
Frequency
Number
How often to attempt to reconnect, in milliseconds.
Blocking
Boolean
If false, the reconnection strategy will run in a separate, non-blocking thread.
Count
Number
How many reconnection attempts the Mule app can make.
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.
Field
Type
Description
Default Value
Required
Frequency
Number
How often to attempt to reconnect, in milliseconds.
Blocking
Boolean
If false, the reconnection strategy will run in a separate, non-blocking thread.
Expiration Policy
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.