Data Types

FolderSettings

The folder's settings, including its description, public download permissions, and storage layer.

Any credentials originally saved in the folder's settings — such as AWS credentials for custom S3 buckets — are omitted by this type.

Structure

Example

{
"description": "This is an example folder description.",
"publicPermissions": [
{
"permissions": {
"file": {
"downloadFile": [
"thumbnail"
]
}
},
"scope": "Children"
}
],
"storageLayer": {
"type": "InternalStorageV2"
}
}

Properties

description

Folder description.

Type: String | Null

Min Length: 1

Max Length: 100

Example: "This is an example folder description."

Required: Yes

publicPermissions

Permissions applied to anonymous users who attempt to download files from a folder.

Each folder can declare these permissions via its FolderSettings object.

Type: PublicPermissions[] | Null

Required: Yes

storageLayer

Storage layer summary information, describing an existing folder's storage layer.

This data type does not contain credentials.

Type: StorageLayerSummary | Null

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: