Go to websiteBook a demoTrust center

Files

Ensure a directory exists at the given path, creating if needed

post
Body
pathstring · pathRequired

The path to ensure a directory exists at

drive_idstring · uuidRequired

The id of the drive we want to make a directory in

share_idany ofOptional

The id of the shared root folder

string · uuidOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
POST /files/directory HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "path": "text",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "share_id": "123e4567-e89b-12d3-a456-426614174000"
}
No content

Ensure a list of directories exist at the given path, creating if needed

post
Body
pathsstring · path[]Required

The paths to ensure directories exist at

drive_idstring · uuidRequired

The id of the drive we want to make a directory in

share_idany ofOptional

The id of the shared root folder

string · uuidOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
POST /files/directory/batch HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "paths": [
    "text"
  ],
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "share_id": "123e4567-e89b-12d3-a456-426614174000"
}
No content

Move a file or folder to a new location

post

Move a file or folder to a new location

Body
sourcestring · pathRequired

The path of the file or folder to move

destinationstring · pathRequired

The path to move the file or folder to

drive_idstring · uuidRequired

The id of the drive containing the file to move

share_idany ofOptional

The id of the shared root folder

string · uuidOptional
or
nullOptional
Responses
200

The new path of the file or folder

application/json
Responseany
post
POST /files/move HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "source": "text",
  "destination": "text",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "share_id": "123e4567-e89b-12d3-a456-426614174000"
}
No content

Move a batch of files or folders to a new location

post

NOTE: this route only works when the sources come from the same folder

Body
sourcesstring · path[]Required

The paths of the files or folders to move

destinationsstring · path[]Required

The path to move the file or folder to

drive_idstring · uuidRequired

The id of the drive containing the file to move

share_idany ofOptional

The id of the shared root folder

string · uuidOptional
or
nullOptional
Responses
200

The new path of the file or folder

application/json
Responsestring · path[]
post
POST /files/move/batch HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "sources": [
    "text"
  ],
  "destinations": [
    "text"
  ],
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "share_id": "123e4567-e89b-12d3-a456-426614174000"
}
[
  "text"
]

Copy a file to a new location

post

Copy a file or folder to a new location

Body
sourcestring · pathRequired

The path of the file or folder to copy

destinationstring · pathRequired

The path to copy the file or folder to

drive_idstring · uuidRequired

The id of the drive containing the file to copy

share_idany ofOptional

The id of the shared root folder

string · uuidOptional
or
nullOptional
Responses
200

The new path of the file

application/json
Responseany
post
POST /files/copy HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "source": "text",
  "destination": "text",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "share_id": "123e4567-e89b-12d3-a456-426614174000"
}
No content

Move a file or folder to the trash

post

Move a file or folder to the trash

Body
pathstring · pathRequired

The path of the file or folder to move to the trash

drive_idstring · uuidRequired

The id of the drive containing the file we want to move to trash

share_idany ofOptional

The id of the shared root folder

string · uuidOptional
or
nullOptional
Responses
200

The new path of the file or folder

application/json
Responseany
post
POST /files/trash HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "path": "text",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "share_id": "123e4567-e89b-12d3-a456-426614174000"
}
No content

Move a file or folder to the trash

post

Move a file or folder to the trash

Body
pathsstring · path[]Required

The paths of the files or folders to move to the trash

drive_idstring · uuidRequired

The id of the drive containing the file we want to move to trash

share_idany ofOptional

The id of the shared root folder

string · uuidOptional
or
nullOptional
Responses
200

The new path of the file or folder

application/json
Responsestring · path[]
post
POST /files/trash/batch HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "paths": [
    "text"
  ],
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "share_id": "123e4567-e89b-12d3-a456-426614174000"
}
[
  "text"
]

Delete a file or folder

post

Delete a file or folder

Body
pathstring · pathRequired

The path of the file or folder to delete

drive_idstring · uuidRequired

The id of the drive containing the file we want to delete

share_idany ofOptional

The id of the shared root folder

string · uuidOptional
or
nullOptional
Responses
200

The path that was deleted

application/json
Responseany
post
POST /files/delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "path": "text",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "share_id": "123e4567-e89b-12d3-a456-426614174000"
}
No content

Delete files or folders in batch

post

Delete files or folders in batch

Body
pathsstring · path[]Required

The paths of the files or folders to delete

drive_idstring · uuidRequired

The id of the drive containing the file we want to delete

share_idany ofOptional

The id of the shared root folder

string · uuidOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responsestring · path[]
post
POST /files/delete/batch HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "paths": [
    "text"
  ],
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "share_id": "123e4567-e89b-12d3-a456-426614174000"
}
[
  "text"
]

Retrieve if a path exists or not on filesystem

get
Query parameters
pathstring · pathRequired

The path to determine if it exists in the filesystem or not

drive_idstring · uuidRequired

The id of the drive containing to check if the file exists in

Body
any ofOptional

The id of the shared root folder

string · uuidOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseboolean
get
GET /files/exists?path=text&drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 38

"123e4567-e89b-12d3-a456-426614174000"
true

Retrieve the storage provider for the files

get
Responses
200

Successful Response

application/json
Responsestring · enumPossible values:
get
GET /files/storage-provider HTTP/1.1
Host: 
Accept: */*

S3

Get the details of assets in a path directory

get

Get the total size of assets in a directory

Query parameters
pathstringRequired

The path to retrieve the total size for

drive_idstring · uuidRequired

The id of the drive this path is in

share_idany ofOptional

The id of the share this path is in

string · uuidOptional
or
nullOptional
exclude_trashbooleanOptional

Whether or not to include the trash folder in the details, if at the drive root.

Default: true
Responses
200

The details of assets in the specified path directory

application/json
get
GET /files/details?path=text&drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

{
  "dir_size_bytes": 1,
  "dir_num_items": 1
}
PreviousFacesNextIndexing