Data Types

FolderSettingsInherited

The FolderSettings inherited by the current path.

If the folder defines its own settings, then those will take effect instead of these inherited settings.

Each inherited setting contains a folderPath field to indicate which folder the setting was inherited from.

Note: if the requester has insufficient privileges to read a setting, that setting's value will be null.

Structure

Example

{
"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
}
}
}

Properties

publicPermissions

The public permissions inherited by the current path.

Type: PublicPermissionsInherited | Null

Required: Yes

storageLayer

The storage layer inherited by the current path.

Type: StorageLayerInherited | 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: