CloudFam
Developer Tools

Build on CloudFam.

Use the CloudFam REST API to upload files, manage your catalog, and monitor traffic quality — all from your own tools and workflows.

Open API Sandbox View Endpoints
Key-based Auth
JSON Responses
REST Architecture
HTTPS Only

Authentication

Required on every request

All API requests require your unique API Key. Include it as a request header named X-API-Key. You can find your key in your dashboard under Settings → API.

Header X-API-Key: YOUR_SECRET_KEY

API Sandbox

Test requests against live data safely

Experiment with requests in a safe environment before integrating. Our sandbox mimics production behavior exactly — including rate limits and error codes.

Launch Sandbox
API Endpoints

Core Endpoints

Upload File 3-Step

Generate a signed URL, transfer data, then finalize the record.

Step 1 — Create Upload Session

GET /api.php?action=create_upload_url
Response 
{
    "success": true,
    "uploadURL": "https://r2.cloudfam.io/signed/...",
    "key": "temp/USER_123/FILE_XYZ"
}

Step 2 — Upload Binary Data

PUT Send raw bytes to uploadURL
cURL 
curl -X PUT "UPLOAD_URL" \
  -H "Content-Type: application/zip" \
  --data-binary @file.zip

Step 3 — Finalize

POST /api.php?action=finalize_upload
Body (JSON) 
{
    "key": "KEY_FROM_STEP_1",
    "original_filename": "my-file.zip"
}

List Files

Retrieve active files and metadata from your account.

GET /api.php?action=view_files
Response 
{
    "success": true,
    "files": [
        {
            "id": 101,
            "filename": "project_v2.zip",
            "size": 1048576,
            "downloads": 450
        }
    ]
}

Delete Files

Move files to trash. Auto-cleared after 30 days.

POST /api.php?action=delete_files
Body (JSON) 
{ "file_ids": [101, 102] }

Traffic Quality

Check your current traffic score (0–100). Scores above 80 indicate high-quality, monetisable traffic.

GET /api.php?action=traffic_quality
Response 
{ "success": true, "score": 92 }

Need more help?

Check our Help Center or ping us on Telegram.

Help Center Telegram