Complete reference for the XCloudEx API v3.0. Build scalable applications with our Firebase-like backend services.
Low latency, high throughput
End-to-end encryption
Auto-scales with your needs
https://api.ulibtech.orgMost endpoints require authentication. Include your API key or JWT token in the request headers.
// With Bearer Token Authorization: Bearer <your-jwt-token> // With API Key X-API-Key: <your-api-key>
// Create a new document
curl -X POST 'https://api.ulibtech.org/api/projects/{projectId}/collections/{collectionId}/documents' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"title": "Hello World",
"content": "This is my first document"
}
}'| Method | Endpoint | Description | Action |
|---|---|---|---|
| GET | /health | Health check | |
| GET | /api/status | System status |
| Method | Endpoint | Description | Action |
|---|---|---|---|
| POST | /api/auth/register | Register user | |
| POST | /api/auth/login | Login | |
| POST | /api/auth/logout | Logout | |
| GET | /api/auth/me | Get current user | |
| PATCH | /api/auth/update-profile | Update profile |
| Method | Endpoint | Description | Action |
|---|---|---|---|
| GET | /api/projects | List projects | |
| POST | /api/projects | Create project | |
| GET | /api/projects/{id} | Get project | |
| PUT | /api/projects/{id} | Update project | |
| DELETE | /api/projects/{id} | Delete project | |
| GET | /api/projects/{id}/members | List members | |
| DELETE | /api/projects/{id}/members/{userId} | Remove member |
| Method | Endpoint | Description | Action |
|---|---|---|---|
| GET | /api/projects/{id}/collections | List collections | |
| POST | /api/projects/{id}/collections | Create collection | |
| GET | /api/projects/{id}/collections/{collectionId} | Get collection | |
| PUT | /api/projects/{id}/collections/{collectionId} | Update collection | |
| DELETE | /api/projects/{id}/collections/{collectionId} | Delete collection |
| Method | Endpoint | Description | Action |
|---|---|---|---|
| GET | /api/projects/{id}/collections/{collectionId}/documents | List documents | |
| POST | /api/projects/{id}/collections/{collectionId}/documents | Create document | |
| GET | /api/projects/{id}/collections/{collectionId}/documents/{docId} | Get document | |
| PUT | /api/projects/{id}/collections/{collectionId}/documents/{docId} | Update document | |
| DELETE | /api/projects/{id}/collections/{collectionId}/documents/{docId} | Delete document | |
| GET | /api/projects/{id}/collections/{collectionId}/documents/{docId}/history | Document history |
| Method | Endpoint | Description | Action |
|---|---|---|---|
| GET | /api/files | List files | |
| GET | /api/files/{id} | Get file info |
| Method | Endpoint | Description | Action |
|---|---|---|---|
| GET | /api/keys | List API keys | |
| POST | /api/keys | Create API key | |
| DELETE | /api/keys/{id} | Revoke API key |
| Method | Endpoint | Description | Action |
|---|---|---|---|
| GET | /api/stats/usage | Usage statistics | |
| GET | /api/stats/collections | Collection statistics | |
| GET | /api/stats/performance | Performance metrics |
| Method | Endpoint | Description | Action |
|---|---|---|---|
| GET | /api/admin/stats/overview | Admin overview |