Files
v4.1.0+Allows full control for the connected file driver. The API key determines the allowed operations.
List files
GET /api/files/list
Query params:
| Field | Value | Type |
|---|---|---|
path | folder path | string |
Example:
Example
/api/files/list?path=folder1/subfolder2Please note, the actual (full) file name includes the folder (e.g. folder1/subfolder2/test2.png).
Exists
GET /api/files/exists
Query params:
| Field | Value | Type |
|---|---|---|
path | file path | string |
Example:
Example
/api/files/exists?path=folder1/subfolder2/test2.pngGet download URL
GET /api/files/getDownloadUrl
Query params:
| Field | Value | Type |
|---|---|---|
path | file path | string |
Example:
Example
/api/files/getDownloadUrl?path=folder1/subfolder2/test2.pngDownload links for local file system drivers require the Data+ API authentication.
Get upload URL
GET /api/files/getUploadUrl
Query params:
| Field | Value | Type |
|---|---|---|
path | file path | string |
overwrite (optional) | overwrite existing files | boolean |
Example:
Example
/api/files/getUploadUrl?path=folder1/subfolder2/test2.pngUpload links for local file system drivers require the Data+ API authentication.
Move/Rename
POST /api/files/move /api/files/rename
Body:
| Field | Value | Type |
|---|---|---|
sourcePath | file path | string |
destinationPath | file path | string |
Example
{
"sourcePath":"folder1/subfolder2/test2.png",
"destinationPath":"folder1/subfolder2/test2_new.png"
}Delete
POST /api/files/delete
Delete a file from the file system.
Body:
| Field | Value | Type |
|---|---|---|
path | file path | string |
Example
{
"path":"folder1/subfolder2/test2.png"
}Create folder
POST /api/files/createFolder
Body:
| Field | Value | Type |
|---|---|---|
path | folder path | string |
Example
{
"path":"folder1/subfolder2"
}Delete folder
POST /api/files/deleteFolder
Also deletes all files inside the folder.
Body:
| Field | Value | Type |
|---|---|---|
path | folder path | string |
Example
{
"path":"folder1/subfolder2"
}Last updated on