Data Types

GetFolderDetails

Gets the settings for this folder.

Returns an empty object if none exist.

GET /v2/accounts/{accountId}/folders
cURL
1curl https://api.upload.io/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 "thumbnail"
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 "thumbnail"
30 ]
31 }
32 },
33 "scope": "Children"
34 }
35 ]
36 },
37 "storageLayer": {
38 "folderPath": "/uploads",
39 "value": {
40 "type": "InternalStorageV1"
41 }
42 }
43 },
44 "status": "Deleting",
45 "type": "Folder"
46}

Response Body

URL Parameters

accountId

Your account ID.

This is visible on the settings page:

https://upload.io/dashboard/settings

Type: String

Length: 7

Example: A623uY2

In: Path

Required: Yes

folderPath

Absolute path to a folder. Must begin with a /. Should not end with a /.

Type: String

Min Length: 1

Max Length: 512

Example: ?folderPath=/uploads

In: Querystring

Required: Yes

Request Headers

Authorization

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, specifying apikey as your username, and your API key as your password.

Type: String

In: Header

Required: Yes

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: