Data Types

PutFolder

Creates or updates the folder specified by the folderPath.

If the folder's ancestors do not exist, they will be created automatically (with empty FolderSettings).

Note: you don't need to create folders before uploading files to them.

PUT /v2/accounts/{accountId}/folders
cURL
1curl https://api.upload.io/v2/accounts/{accountId}/folders \
2 -X PUT \
3 -H "Authorization: Bearer YOUR_API_KEY" \
4 -H "Content-Type: application/json" \
5 -d @- << EOF
6 {
7 "allowUnnamedFolder": false,
8 "folderPath": "/uploads",
9 "folderSettings": {
10 "description": {
11 "set": true,
12 "value": "This is an example folder description."
13 },
14 "publicPermissions": {
15 "set": true,
16 "value": [
17 {
18 "permissions": {
19 "file": {
20 "downloadFile": [
21 "thumbnail"
22 ]
23 }
24 },
25 "scope": "Children"
26 }
27 ]
28 },
29 "storageLayer": {
30 "set": true,
31 "value": {
32 "type": "InternalStorageV2"
33 }
34 }
35 }
36 }
37EOF
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}

Request Body

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

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

Content-Type

This endpoints requires a JSON request body.

Type: String

Value: "application/json"

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: