API Documentation

Everything you need to know about the CDNSigma API

Quick Navigation

Authentication
Permissions
Endpoints
Rate Limiting
File Limits

🔑 API Key Required

All API endpoints require an API key to be included in the request headers:

X-API-Key: your_api_key_here

Available Permissions

Permission	Description
`add_file`	Allow uploading files
`view_file`	Allow viewing file details
`view_folder`	Allow viewing folder contents
`delete_file`	Allow deleting files
`create_api`	Allow creating new API keys
`delete_api`	Allow deleting API keys
`ban`	Allow banning IP addresses
`unban`	Allow unbanning IP addresses

Endpoints

Upload File

POST

/api/upload

Upload one or more files to the service.

Required Permissions:

add_file

Request Format:

multipart/form-data

Parameters:

file - The file(s) to upload (multiple files allowed)
folder_name (optional) - Custom folder name (default: random UUID)

👉 Show Example Response

{
    "success": true,
    "folder_id": "folder_name",
    "files": [
        {
            "name": "filename.ext",
            "url_us": "https://us.cdnsigma.xyz/folder_name/filename.ext",
            "url_eu": "https://eu.cdnsigma.xyz/folder_name/filename.ext",
            "size": 1234,
            "content_type": "application/octet-stream"
        }
    ]
}

Get File Information

GET

/api/files/{file_id}

Get detailed information about a specific file.

Required Permissions:

view_file

👉 Show Example Response

{
    "success": true,
    "file": {
        "name": "filename.ext",
        "url": "https://[region].cdnsigma.xyz/file_id",
        "url_us": "https://us.cdnsigma.xyz/file_id",
        "url_eu": "https://eu.cdnsigma.xyz/file_id",
        "content_type": "application/octet-stream",
        "last_modified": "2024-03-21T12:00:00Z",
        "size": 1234
    }
}

List Folder Contents

GET

/api/folders/{folder_id}

Get a list of all files in a folder.

Required Permissions:

view_folder

👉 Show Example Response

{
    "success": true,
    "folder_id": "folder_name",
    "files": [
        {
            "name": "filename.ext",
            "size": 1234,
            "last_modified": "2024-03-21T12:00:00Z",
            "url_us": "https://us.cdnsigma.xyz/folder_name/filename.ext",
            "url_eu": "https://eu.cdnsigma.xyz/folder_name/filename.ext"
        }
    ],
    "total_size": 1234,
    "file_count": 1
}

Delete File/Folder

DELETE

/api/files/{file_id}

Delete a file or folder and all its contents.

Required Permissions:

delete_file

👉 Show Example Response

{
    "success": true,
    "message": "File/Folder deleted successfully",
    "deleted_count": 1
}

Create API Key

POST

/api/keys/custom

Create a new API key with custom permissions.

Required Permissions:

create_api

Request Body:

{
    "permissions": ["add_file", "view_file"],
    "description": "Custom API key",
    "public_ratelimiting": false,
    "prefix": "custom_"  // optional
}

👉 Show Example Response

{
    "success": true,
    "api_key": "custom_abc123...",
    "permissions": ["add_file", "view_file"],
    "description": "Custom API key",
    "public_ratelimiting": false
}

Delete API Key

DELETE

/api/keys/{api_key}

Delete an existing API key.

Required Permissions:

delete_api

👉 Show Example Response

{
    "success": true,
    "message": "API key deleted successfully"
}

Ban IP Address

POST

/api/ban

Ban an IP address from accessing the service.

Required Permissions:

ban

Request Body:

{
    "ip": "1.2.3.4",
    "reason": "Violation of terms of service"
}

👉 Show Example Response

{
    "success": true,
    "message": "IP 1.2.3.4 has been banned",
    "ban_info": {
        "timestamp": "2024-03-21T12:00:00Z",
        "reason": "Violation of terms of service"
    }
}

Unban IP Address

POST

/api/unban

Remove an IP address from the ban list.

Required Permissions:

unban

Request Body:

{
    "ip": "1.2.3.4"
}

👉 Show Example Response

{
    "success": true,
    "message": "IP 1.2.3.4 has been unbanned"
}

List Banned IPs

GET

/api/bans

Get a list of all banned IP addresses.

Required Permissions:

ban
unban

👉 Show Example Response

{
    "success": true,
    "banned_ips": {
        "1.2.3.4": {
            "timestamp": "2024-03-21T12:00:00Z",
            "reason": "Violation of terms of service"
        }
    }
}

Check API Key Permissions

GET

/api/permissions

Get the permissions associated with your API key.

Required Permissions:

all

👉 Show Example Response

{
    "success": true,
    "permissions": ["add_file", "view_file"],
    "description": "Custom API key"
}

⚡ Rate Limiting

Public API keys (those starting with 'public_') are subject to rate limiting. Custom API keys can also have rate limiting enabled when created.

📁 File Size Limits

The maximum file size allowed for upload is 2GB.