Gets the full details (e.g. permission, storage layer, etc.) for a folder.
Returns an empty object if no settings have been configured for this folder.
Requires a secret_* API key. Alternatively, you can use a public_* API key and JWT-based auth.
1curl "https://api.bytescale.com/v2/accounts/{accountId}/folders?folderPath=/uploads" \2 -H "Authorization: Bearer YOUR_API_KEY"
1{2 "folderPath": "/uploads",3 "settings": {},4 "settingsInherited": {5 "publicPermissions": {6 "folderPath": "/",7 "value": [8 {9 "scope": "Children",10 "permissions": {11 "file": {12 "downloadFile": [13 "*"14 ]15 }16 }17 }18 ]19 },20 "storageLayer": {21 "folderPath": "/",22 "value": {23 "type": "InternalStorageV2"24 }25 }26 },27 "type": "Folder",28 "virtual": true29}
Your account ID.
This is visible on the settings page:
https://www.bytescale.com/dashboard/settings
Example: "A623uY2"
Type: String
Length: 7
Absolute path to a folder. Begins with a /. Should not end with a /.
Example: "/uploads"
Type: String
Min Length: 1
Max Length: 512
Add one of these Authorization header values to your request:
•Option 1: prefix "Bearer " to your API key. The result is your Authorization header value.
•Option 2: use HTTP basic authorization with apikey as your username and your API key as your password.
For advanced options, please see:
https://www.bytescale.com/docs/auth
Note: this endpoint requires a secret_* API key.
Type: String
This website uses cookies. By continuing you are consenting to the use of cookies per our Cookie Policy. Our legal policies were last updated August 16 2024.
This website requires a modern web browser -- the latest versions of these browsers are supported: