Data Types

PutFolderRequest

Request body for PutFolder.

{
"allowUnnamedFolder": false,
"folderPath": "/uploads",
"folderSettings": {
"description": {
"set": true,
"value": "This is an example folder description."
},
"publicPermissions": {
"set": true,
"value": [
{
"permissions": {
"file": {
"downloadFile": [
"*"
]
}
},
"scope": "Children"
}
]
},
"storageLayer": {
"set": true,
"value": {
"bucket": {
"bucketName": "my-bucket",
"bucketRegion": "nyc3",
"objectKeyPrefix": "an/example/key"
},
"credentials": {
"spacesAccessKey": "AKIAIOSFODNN7EXAMPLE",
"spacesSecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
},
"type": "DigitalOceanSpace",
"useAbsolutePaths": true
}
}
}
}

You must specify true if the folderPath ends with a /.

This prevents the accidental creation of folders that produce file paths with double forward-slashes in them.

Default: false

Type: Boolean

Absolute path to a folder. Begins with a /. Should not end with a /.

Example: "/uploads"

Type: String

Min Length: 1

Max Length: 512

Specifies the folder settings to use when creating or updating a folder.

Type: PatchFolderSettings

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: