Data Types

FolderSummary

Summary information about a folder (a subset of the FolderDetails type).

Structure

{
"folderPath": String,
"status": String,
"type": String
}

Example

{
"folderPath": "/uploads",
"settings": {
"description": "This is an example folder description.",
"publicPermissions": [
{
"permissions": {
"file": {
"downloadFile": [
"thumbnail"
]
}
},
"scope": "Children"
}
],
"storageLayer": {
"type": "InternalStorageV2"
}
},
"status": "Deleting",
"type": "Folder"
}

Properties

folderPath

This folder's path. Always begins with a /.

Type: String

Min Length: 1

Max Length: 512

Example: "/uploads"

Required: Yes

settings

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

Type: FolderSettings

Required: Yes

status

The folder's status.

Type: String

Allowed Values: "Deleting", "Ok"

Required: Yes

type

Type: String

Value: "Folder"

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: