Data Types

FolderDetails

{
"folderPath": "/uploads",
"settings": {
"description": "This is an example folder description.",
"publicPermissions": [
{
"permissions": {
"file": {
"downloadFile": [
"*"
]
}
},
"scope": "Children"
}
],
"storageLayer": {
"type": "InternalStorageV2"
}
},
"settingsInherited": {
"publicPermissions": {
"folderPath": "/uploads",
"value": [
{
"permissions": {
"file": {
"downloadFile": [
"*"
]
}
},
"scope": "Children"
}
]
},
"storageLayer": {
"folderPath": "/uploads",
"value": {
"bucket": {
"bucketName": "my-bucket",
"bucketRegion": "nyc3",
"objectKeyPrefix": "an/example/key"
},
"type": "DigitalOceanSpace",
"useAbsolutePaths": true
}
}
},
"type": "Folder",
"virtual": true
}

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

Example: "/uploads"

Type: String

Min Length: 1

Max Length: 512

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

Type: FolderSettings

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

Indicates this item is a folder (as opposed to a file).

Type: String

Value: "Folder"

If true then the folder was created using the PutFolder operation.

If false then the folder was created automatically as the result of a file upload operation, and will disappear if/when the folder later becomes empty.

Type: Boolean

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: