Data Types

GetFolderDetails

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.

GET /v2/accounts/{accountId}/folders
cURL
1curl "https://api.bytescale.com/v2/accounts/{accountId}/folders?folderPath=/uploads" \
2 -H "Authorization: Bearer YOUR_API_KEY"
Response (200)
1{
2 "folderPath": "/uploads",
3 "settings": {
4 "description": "This is an example folder description.",
5 "publicPermissions": [
6 {
7 "permissions": {
8 "file": {
9 "downloadFile": [
10 "*"
11 ]
12 }
13 },
14 "scope": "Children"
15 }
16 ],
17 "storageLayer": {
18 "type": "InternalStorageV2"
19 }
20 },
21 "settingsInherited": {
22 "publicPermissions": {
23 "folderPath": "/uploads",
24 "value": [
25 {
26 "permissions": {
27 "file": {
28 "downloadFile": [
29 "*"
30 ]
31 }
32 },
33 "scope": "Children"
34 }
35 ]
36 },
37 "storageLayer": {
38 "folderPath": "/uploads",
39 "value": {
40 "bucket": {
41 "bucketName": "my-bucket",
42 "bucketRegion": "nyc3",
43 "objectKeyPrefix": "an/example/key"
44 },
45 "type": "DigitalOceanSpace",
46 "useAbsolutePaths": true
47 }
48 }
49 },
50 "type": "Folder",
51 "virtual": true
52}

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

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: