Data Types

FolderDetails

Structure

Example

{
"folderPath": "/uploads",
"settings": {
"description": "This is an example folder description.",
"publicPermissions": [
{
"permissions": {
"file": {
"downloadFile": [
"thumbnail"
]
}
},
"scope": "Children"
}
],
"storageLayer": {
"type": "InternalStorageV2"
}
},
"settingsInherited": {
"publicPermissions": {
"folderPath": "/uploads",
"value": [
{
"permissions": {
"file": {
"downloadFile": [
"thumbnail"
]
}
},
"scope": "Children"
}
]
},
"storageLayer": {
"folderPath": "/uploads",
"value": {
"type": "InternalStorageV1"
}
}
},
"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

settingsInherited

The FolderSettings inheritable from the folder's ancestors.

If both the settings field and the settingsInherited field define the same setting (e.g. the storageLayer setting) then the value from the settings field is used for the current folder and its descendants.

Type: FolderSettingsInherited

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: