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

{
  "description": String,
  "publicPermissions": PublicPermissions[],
  "storageLayer": StorageLayerSummary
}

Example

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

Properties

description Optional

Folder description.

Example: "This is an example folder description."

Type: String

Min Length: 1

Max Length: 100

publicPermissions Optional

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[]

storageLayer Optional

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

This data type does not contain credentials.

Type: StorageLayerSummary

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:

UI Widgets

SDKs

Processing APIs

Core APIs

Data Types

More Resources

FolderSettings

Structure

Example

Properties

description Optional

publicPermissions Optional

storageLayer Optional

Used by

You are using an outdated browser.