Usage

To use the options listed below, you would need to add the option to the "transfer": { } block when creating/editing a job using the REST API. Each colon (:) indicates a nested property. For example, to use source:size_estimate:bytes, you should include it as:

POST v1/jobs

{
    "name": "test copy",
    "kind": "transfer",
    "transfer": {
        "transfer_type": "copy",
        "source": {
            "connection": {
                "id": "5dc531df34554edd96c31272262ad950"
            },
            "target": {
                "path": "/C/data"
            },
            "size_estimate": {
                "bytes": 10240
            }
        },
        "destination": {
            "connection": {
                "id": "bb44a17816004f2c9fa763a347d7ebbc"
            },
            "target": {
                "path": "/Documents/test"
            }
        }
    },
    "schedule": {
        "mode": "manual"
    }
}

The following example shows how to use empty_containers with a setting of skip, in conjunction with an exclusion filter.

POST v1/jobs

{
 "name":"Copy Job Skip Empty Folders",
 "kind": "transfer",
 "transfer": {
     "audit_level": "trace",
     "transfer_type": "copy",
     "empty_containers": "skip",
      "filter": {
           "source": [{
             "action": "exclude",
                "rules": [{
                   "extensions": [
                        "wav",
                        "jpg"
                    ],
                    "type": "filter_extension"
                }],
                "type": "filter_rule"
               }
           ]
      },
     "source": {
       "connection": { "id": "{{nfs_connection}}" },
       "target": {
         "path": "/EmptyTest_Source"
       }
     },
     "destination": {
       "connection": { "id": "{{cloud_connection}}" },
       "target": {
         "path": "/EmptyTest_Destination"
       }
 },
 "schedule": {
   "mode": "manual"
  }
 }
}

Options