API Overview
Complete API documentation for integrating with Cliqer
This feature is included while in early access.
API Reference
Complete documentation for the Cliqer API, covering REST endpoints and WebSocket realtime communication.
Base URL
All API endpoints are relative to the base URL of the Cliqer server you're connecting to.
Code Examples: In curl/Python/Go examples, replace
$BASE_URL with your Cliqer instance URL (e.g., ). For WebSocket examples, replace $WS_URL with . TypeScript examples use relative paths and work without modification.Authentication
All API requests require authentication via Bearer token in the Authorization header.
Authorization: Bearer YOUR_ACCESS_TOKEN
See Authentication for token generation, API key management, and security best practices.
API Sections
Error Responses
All endpoints return standard error responses:
| Status | Description |
|---|---|
400 | Bad Request - Missing or invalid parameters |
401 | Unauthorized - Invalid or missing token |
403 | Forbidden - Insufficient permissions |
404 | Not Found - Resource not found |
500 | Internal Server Error |
Error Response Format:
{
"statusCode": 400,
"message": "Description of the error"
}
Rate Limiting
All endpoints include rate limiting with progressive blocking for repeated violations.
| Header | Description |
|---|---|
X-RateLimit-Remaining | Requests remaining in current window |
Retry-After | Seconds until rate limit resets (when blocked) |
Endpoint-Specific Limits
| Category | Requests/Minute | Block Duration |
|---|---|---|
| License Validation | 5 | 2-60 min |
| License Status/Deactivate | 10-30 | 1-30 min |
| TURN Credentials | 10 | 5-60 min |
| Connection Management | 10-30 | 1-60 min |
Rate limit violations result in progressively longer block durations. Repeated abuse may result in IP blocks up to 1 hour.