API Reference
Complete reference for the SoliDB HTTP API. All endpoints are prefixed with /_api unless otherwise noted.
Performance & Formats
SoliDB supports multiple serialization formats to optimize performance. While JSON is the default for ease of use, MessagePack is strongly recommended for production environments to reduce payload size and parsing overhead.
JSON
JSON (Default)
Human-readable, universally supported.
MP
MessagePack (Fast)
Binary format, smaller payloads, faster parsing.
API Categories
Click on a category to view detailed endpoint documentation.
Databases
Create, list, and delete databases.
Collections
Collections, schemas, and columnar storage.
Documents
CRUD operations for documents.
Queries
SDBQL, SQL compatibility, and cursors.
Indexes
Create and manage indexes including TTL.
Scripting
Lua scripts and custom API endpoints.
Blobs
Binary data upload and download.
Transactions
ACID transactions with isolation levels.
Cluster
Cluster status, nodes, and rebalancing.
Authentication
Login, API keys, roles, and users.
Jobs
Queues and cron job scheduling.
Monitoring
Health checks and Prometheus metrics.
Quick Reference
Common Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /_api/database/:db/query | Execute SDBQL query |
| POST | /_api/document/:db/:coll | Insert document |
| GET | /_api/document/:db/:coll/:key | Get document by key |
| PUT | /_api/document/:db/:coll/:key | Update document |
| DELETE | /_api/document/:db/:coll/:key | Delete document |
| POST | /auth/login | Get JWT token |
| GET | /metrics | Prometheus metrics |
JWT Authentication
Login to get a token, then include it in requests:
API Key Authentication
Alternatively, use an API key:
Public endpoints: /auth/login, /_api/health, and /metrics do not require authentication.