Base URL
All API endpoints are relative to your copyparty server’s base URL:API Categories
copyparty’s HTTP API is organized into several functional areas:Upload API
Upload files using PUT, multipart POST, or the resumable up2k protocol
Download API
Download files, folders as zip/tar archives, and stream content
Search API
Search files by name, tags, metadata, and content hashes
Authentication
Authenticate requests using headers, cookies, or URL parameters
HTTP Methods
copyparty supports standard HTTP methods:- GET - Retrieve files, listings, and metadata
- HEAD - Get file metadata without downloading
- POST - Upload files (multipart), search, administrative actions
- PUT - Upload files directly
- DELETE - Delete files and folders (requires permissions)
Response Formats
The API supports multiple response formats:- JSON - Structured data for search results, file listings
- HTML - Browser-friendly views
- Plaintext - Simple listings for scripts
- Binary - File downloads, thumbnails
Common URL Parameters
Many endpoints support these URL parameters:string
default:"json"
List files/folders. Values: blank (JSON),
t (plaintext), v (terminal-formatted)string
Authentication password. Format:
password or username:password if --usernames is enabledboolean
Include dotfiles in listings (requires permission)
boolean
Return JSON response instead of plaintext
CORS Support
All non-GET/HEAD requests require CORS validation. Configure CORS settings with:--no-cors- Disable CORS checks--no-cors-s- Disable CORS for same-host requests
Rate Limiting
Some endpoints implement rate limiting:- Search: 0.7 second penalty between searches that take > 0.7s
- Uploads: Configurable with
--ban-pw(default: 24h ban for 9 failed auth attempts)
Error Codes
Security Notes
Client Libraries
Official clients:- Python: u2c.py - Command-line uploader
- FUSE: partyfuse.py - Mount as filesystem
Next Steps
Upload Files
Learn about upload endpoints and the up2k protocol
Download Files
Download files and create archives