On This Page
Overview
Files may be included in or excluded from transfers based on metadata attributes, file size, item name patterns, and extensions. This feature is useful for customers who need to transfer only a subset of items based on certain file characteristics.
If you need to add multiple filters to an include or exclude rule, you must ensure you handle them as follows:
Multiple Exclude Filters: You must add a separate exclude rule for each filter you want to use.
Multiple Include Filters: You must add all filters to one include rule.
When using multiple filters, any include filters will be overwritten/ignored if an overlapping exclude filter is included on the job. For example, if you choose to include a specific file based on path but the file type meets a type specified in an exclude filter, the file will not transfer.
Job Filter Options
For information about specific filters, refer to the corresponding documentation page.
General REST API Format
Filters are applied through the REST API by adding a filter block within the transfer block of a transfer job body when calling the REST API (POST .../v1/jobs) or using the CLI to create a job. A source or destination block or both may be defined. Each refers to the source and destination connections for the job. Note that the filter block is placed within the transfer block. The action value is set to either exclude or include.
Include items that match any rule: Transfer items that match any of the defined rules in this filter. Exclude all other content.
Exclude items that match any rule: Exclude items that match any of the defined rules in this filter. All other content will be transferred.
If the action attribute is missing or set to null, the default action is set to exclude.
{
...
"transfer": {
...
"filter": {
"[source|destination]": [{
"action": "[exclude|include]",
"rules": [{...}],
"type": "filter_rule"
}
]
}
}
...
}