Download Objects
Download single files or multiple files as a ZIP archive.
| Endpoint | Method | Admin Required |
|---|---|---|
/api/v1/objects/download | POST | No |
Downloads one or more objects from a bucket you own. Single files are returned directly; multiple files or folders are packaged as a ZIP archive.
Request Body
bucket
string required
Name of the bucket to download from.
keys
string[] required
Array of object keys to download. Use trailing
/ for folders.versionId
string
Specific version to download (for single file downloads only).
Single File Example
{
"bucket": "my-bucket",
"keys": ["documents/report.pdf"]
}
Multiple Files Example
{
"bucket": "my-bucket",
"keys": ["image1.png", "image2.png", "documents/"]
}
Specific Version Example
{
"bucket": "my-bucket",
"keys": ["report.pdf"],
"versionId": "abc123def456"
}
Response
Single File
Returns the file with appropriate headers:
| Header | Value |
|---|---|
Content-Type | File's MIME type |
Content-Disposition | attachment; filename="filename.ext" |
Content-Length | File size in bytes |
Multiple Files / Folders
Returns a ZIP archive:
| Header | Value |
|---|---|
Content-Type | application/zip |
Content-Disposition | attachment; filename="{bucket}-download.zip" |
Content-Length | ZIP file size in bytes |
Errors
| Status | Reason |
|---|---|
400 | No keys provided |
404 | Bucket not found, object not found, or delete marker |
500 | Failed to read object or create ZIP |