API docs by Redocly

Dropzone API (1.0.0)

Download OpenAPI specification:

Dropzones - the new cloud file management API

The Idea

Dropzones provide a super simple and secure way to store files in the cloud from within your own app, website or service. No need to deal with complex file management systems, buckets or complicated APIs. Just create a dropzone, upload files and manage them with ease. Please note that by using this API you agree to the Terms of Service and Privacy Policy.

Dropzones

Create a new dropzone

Creates a new dropzone with the specified parameters.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
gb
number [ 0.2 .. 4 ]

The storage size in GB.

days
number [ 30 .. 365 ]

The number of days the dropzone will be active.

Responses

Request samples

Content type
application/json
{
  • "gb": 1,
  • "days": 90
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update a dropzone.

Updates the specified dropzone with new parameters. If the new size or duration is greater than the current size or duration, the dropzone will be extended accordingly. This operation consumes exactly the new amount of GB-Months you want to extend the dropzone with.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
gb
number [ 0.2 .. 4 ]

The new storage size in GB. Must be greater than the current size.

days
number [ 30 .. 365 ]

The number of days the dropzone will be active. Must be greater than the current duration.

Responses

Request samples

Content type
application/json
{
  • "gb": 1,
  • "days": 90
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Get dropzone details

Retrieves details of a specific dropzone.

Authorizations:
DropzoneAuth

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Files

List all my files

Retrieves a list of files in the dropzone.

Authorizations:
DropzoneAuth

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Request an upload URL

Returns a signed S3 URL and fileId for direct upload to S3 for the given file metadata. This will already consume the storage quota of the dropzone, so ensure that the dropzone has enough space available. The file will not be immediately available in the dropzone until the upload is confirmed.

Authorizations:
DropzoneAuth
Request Body schema: application/json
name
required
string

The name of the file to be uploaded.

type
required
string

The MIME type of the file.

size
required
integer

The size of the file in bytes.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "size": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Confirm a file upload

Confirms that a file has been uploaded to S3 and finalizes the file in the system. No request body is required.

Authorizations:
DropzoneAuth
path Parameters
fileId
required
string

The ID of the file to confirm.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "size": 0,
  • "type": "string",
  • "name": "string",
  • "meta": {
    }
}

Get file details

Retrieves details of a specific file.

Authorizations:
DropzoneAuth
path Parameters
fileId
required
string

The ID of the file.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "size": 0,
  • "type": "string",
  • "name": "string",
  • "meta": {
    }
}

Delete a file

Deletes a specific file from the specified dropzone.

Authorizations:
DropzoneAuth
path Parameters
fileId
required
string

The ID of the file.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "File deleted successfully."
}

Download a file

Downloads a specific file.

Authorizations:
DropzoneAuth
path Parameters
fileId
required
string

The ID of the file.

Responses

Response samples

Content type
application/json
{
  • "status": "error",
  • "message": "Missing dropzoneId or fileId."
}