Documentation

Interface Version 2.4.0

Introduction Authentication File Upload List Buckets & Files Resource Management Deleting Resources Error Handling

Endpoint Status: Operational

Qolek Q3 API Reference

Welcome to the Qolek Q3 API. Our platform provides a simple, S3-compatible experience for cloud storage. You can easily manage buckets, upload large files, and secure your data using project API keys.
API Base URL
https://q3.qolek.com/api/v1

Security & Authentication

To authenticate your requests, you must include two mandatory headers in every API call. These keys can be generated from your Project Dashboard.

Header Key Description / Logic
X-API-Key Your public unique project identifier.
X-Secret-Key Your private authentication token. Keep this secure.
CURL Implementation Example
curl -X GET "https://q3.qolek.com/api/v1/buckets" \
  -H "X-API-Key: YOUR_PROJECT_KEY" \
  -H "X-Secret-Key: YOUR_SECRET_KEY"

Object Storage (Upload)

Support for multipart form-data. You can upload any file type as as independent asset or archive.

POST Endpoint
POST https://q3.qolek.com/api/v1/upload
Required Parameters
  • bucket_name (String) — The unique name of your destination container.
  • file (Binary) — The actual resource/file you wish to store.
Success Response (JSON)
{
  "success": true,
  "file_url": "https://q3.qolek.com/storage/p1/yourfile.png",
  "file_name": "yourfile.png",
  "size": 102456
}

List Buckets & Files

Fetch your active containers or retrieve existing files within a project. All responses are paginated by default.

List All Buckets
https://q3.qolek.com/api/v1/buckets
List All Files
https://q3.qolek.com/api/v1/files

Resource Management

Perform administrative actions on your stored resources via API.

POST /api/v1/folder
Create a subfolder

Creates a virtual directory within a bucket (using a .gitkeep marker).

Params: bucket (String), path (String)
PATCH /api/v1/file/rename
Rename File or Folder
Params: path (String), new_name (String), bucket (Optional)
PATCH /api/v1/file/visibility
Toggle Public/Private

Flips the current is_public status of the object.

Params: path (String), bucket (Optional)

Delete Resources

You can programmatically delete files or buckets. This action is irreversible and will permanently remove the data from our servers.

DELETE Endpoint
DELETE https://q3.qolek.com/api/v1/file
CURL Deletion Example
curl -X DELETE "https://q3.qolek.com/api/v1/file" \
  -H "X-API-Key: YOUR_PROJECT_KEY" \
  -H "X-Secret-Key: YOUR_SECRET_KEY" \
  -d "path=folder1/yourfile.png&bucket=my-bucket"
Accepted Parameters
  • path (String) — The relative path or filename you wish to delete.
  • bucket (String, Optional) — Specify which bucket the file belongs to.

Qolek Q3 API — Standalone Cloud Storage.

© 2026 All Rights Reserved.