Files

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

post

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

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

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

/files/directory

HTTPcURLJavaScriptPython

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

{
  "path": "text",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

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

post

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

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

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

/files/directory/batch

HTTPcURLJavaScriptPython

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

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

No content

Move a file or folder to a new location

post

Move a file or folder to a new location

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

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

Responses

200

The new path of the file or folder

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

/files/move

HTTPcURLJavaScriptPython

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

{
  "source": "text",
  "destination": "text",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

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

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

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

Responses

200

The new path of the file or folder

application/json

Responsestring · path[]

404

Not found

422

Validation Error

application/json

post

/files/move/batch

HTTPcURLJavaScriptPython

POST /files/move/batch HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 140

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

[
  "text"
]

Copy a file to a new location

post

Copy a file or folder to a new location

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

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

Responses

200

The new path of the file

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

/files/copy

HTTPcURLJavaScriptPython

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

{
  "source": "text",
  "destination": "text",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Move a file or folder to the trash

post

Move a file or folder to the trash

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

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

404

Not found

422

Validation Error

application/json

post

/files/trash

HTTPcURLJavaScriptPython

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

{
  "path": "text",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "share_id": "123e4567-e89b-12d3-a456-426614174000",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Move a file or folder to the trash

post

Move a file or folder to the trash

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

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[]

404

Not found

422

Validation Error

application/json

post

/files/trash/batch

HTTPcURLJavaScriptPython

POST /files/trash/batch HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 164

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

[
  "text"
]

Delete a file or folder

post

Delete a file or folder

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

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

404

Not found

422

Validation Error

application/json

post

/files/delete

HTTPcURLJavaScriptPython

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

{
  "path": "text",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "share_id": "123e4567-e89b-12d3-a456-426614174000",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Delete files or folders in batch

post

Delete files or folders in batch

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

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

Responses

200

Successful Response

application/json

Responsestring · path[]

404

Not found

422

Validation Error

application/json

post

/files/delete/batch

HTTPcURLJavaScriptPython

POST /files/delete/batch HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 114

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

[
  "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

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseboolean

404

Not found

422

Validation Error

application/json

get

/files/exists

HTTPcURLJavaScriptPython

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

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

true

Retrieve the storage provider for the files

get

Responses

200

Successful Response

application/json

Responsestring · enumPossible values:

404

Not found

get

/files/storage-provider

HTTPcURLJavaScriptPython

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

exclude_trashbooleanOptional

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

Default: true

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

The details of assets in the specified path directory

application/json

404

Not found

422

Validation Error

application/json

get

/files/details

HTTPcURLJavaScriptPython

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

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

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