Data Types

CopyFolderRequest

Request body for CopyFolder.

{
"destination": "/destination/folder",
"source": "/source/folder",
"recursive": true
}

If true then copies files.

Default: true

Type: Boolean

If false then if a file's parent folder has overridden storage settings, the file won't be copied.

If you don't use folders with custom storage settings (like AWS S3 buckets), you don't need to worry about this setting.

Conditional: copyVirtualFolders and copyOverriddenStorage cannot both be true.

Default: false

Type: Boolean

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

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

Arbitrary JSON to store against the copied file(s) as metadata.

Type: CopyFileMetadata

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

Source folder for the copy operation.

Example: "/source/folder"

Type: String

Min Length: 1

Max Length: 512

File tags to store against the copied file(s).

Type: CopyFileTags

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: