CopyFolderRequest

Request body for CopyFolder.

You can use ListFolder to preview the operation: set dryRun=true with recursive, includeFiles, includeOverriddenStorage and includeVirtualFolders set to match the values you're using here. Leave all other flags unset.

Structure

{
  "condition": TagCondition,
  "copyFiles": Boolean,
  "copyOverriddenStorage": Boolean,
  "copyVirtualFolders": Boolean,
  "destination": String,
  "recursive": Boolean,
  "source": String
}

Example

{
  "condition": {
    "equals": "*",
    "type": "Equals"
  },
  "copyFiles": true,
  "copyOverriddenStorage": false,
  "copyVirtualFolders": true,
  "destination": "/destination/folder",
  "recursive": true,
  "source": "/source/folder"
}

Properties

condition

If specified, only files with tags that match this condition will be copied.

Type: TagCondition

Required: No

copyFiles

If true then copies files.

Default: true

Type: Boolean

Required: No

copyOverriddenStorage

If true then copies files from folders that have overridden storage settings, else skips them.

If the current folder inherits its storage settings, then the current folder's files will be copied, assuming copyFiles=true.

You can ignore this setting if your account does not use folders with overridden storage settings, such as custom AWS S3 buckets.

Conditional: copyVirtualFolders and copyOverriddenStorage cannot both be true.

Default: false

Type: Boolean

Required: No

copyVirtualFolders

If true then copies virtual folder settings at the current path and below, else only files will be copied.

Virtual folders are folders that have been created using the PutFolder operation.

Conditional: copyVirtualFolders and copyOverriddenStorage cannot both be true.

Default: true

Type: Boolean

Required: No

destination

Destination folder for the copy operation.

The source folder will be copied to this location (rather than under it).

Example: "/destination/folder"

Type: String

Min Length: 1

Max Length: 512

Required: Yes

recursive

If true then copies files and virtual folders that are descendants of the source folder.

If false then only copies files that are direct children of the source folder, and does not copy descendant virtual folders (children or otherwise).

Default: true

Type: Boolean

Required: No

source

Source folder for the copy operation.

Example: "/source/folder"

Type: String

Min Length: 1

Max Length: 512

Required: Yes

Used by

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported:

File Uploading

File Processing APIs

Data Types

More Resources

CopyFolderRequest

Structure

Example

Properties

condition

copyFiles

copyOverriddenStorage

copyVirtualFolders

destination

recursive

source

Used by

You are using an outdated browser.