Item Overwrite Policy Using REST API
Learn how to set the item overwrite policy for migration jobs using the DryvIQ REST API.
Written by Andrea Harvey
Updated at May 2nd, 2025
Table of Contents
Overview
The Overwrite policy controls DryvIQ's behavior when it detects the same file name on the target platform. The overwrite policy applies only to files; if DryvIQ detects folders with the same name, it merges them.
| Options | Behaviors |
|---|---|
| "item_overwrite": "overwrite" |
This is the recommended and default setting.
When overwrite policy is configured, it will overwrite the target location when DryvIQ detects an event indicating that a change occurred. If no event is detected, the item overwrite policy is not applicable. Item overwrite behaves the same on the first and subsequent runs. Conflict Policy and Delete Policy are also triggered by event detection. However, overwrite policy will take precedence. |
| "item_overwrite": "skip" |
Not recommended/Special case configuration only
When overwrite policy skip is configured, DryvIQ will skip any files that exist on both sides of the given platforms and report it as an error. All other policies may still apply.
This is not a recommended configuration because it can lead to unintended discrepancies between the source and destination. For example, when an event is detected to transfer the file using a conflict policy, overwrite skip setting will take precedence. This will veto the transfer decision for existing files and log a warning message. |
| "item_overwrite": "fail" |
Not recommended / Special case configuration only
When overwrite policy fail is configured, DryvIQ will fail any files that exist on both sides of the given platforms and report it as an error. All other policies may still apply.
This is not a recommended configuration because it can lead to unintended discrepancies between the source and destination. For example, when an event is detected to transfer the file using a conflict policy, overwrite fail setting will take precedence. This will veto the transfer decision for existing files and log a failure message. |
Job JSON Example
{
"name":"Simple Transfer Job with Overwrite Policy",
"kind": "transfer",
"transfer": {
"item_overwrite": "overwrite",
"transfer_type": "copy",
"source": {
"connection": { "id": "{{nfs_connection}}" },
"target": {
"path": "/SourcePath"
}
},
"destination": {
"connection": { "id": "{{cloud_connection}}" },
"target": {
"path": "/DestinationPath"
}
}
},
"schedule": {
"mode": "manual"
}
}