HTTP REST API

Complete REST API reference for NexaDB HTTP interface.

Note: Binary Protocol Recommended

For production applications, we recommend using the binary protocol which is 3-13x faster than HTTP/REST. See Binary Protocol docs.

Base URL

http://localhost:6970

Endpoints

POST/api/create

Create a new document in a collection

{
  "collection": "users",
  "data": {
    "name": "Alice",
    "email": "alice@example.com"
  }
}
GET/api/get/:collection/:id

Retrieve a document by ID

GET /api/get/users/doc_123
PUT/api/update

Update an existing document

{
  "collection": "users",
  "id": "doc_123",
  "data": {
    "name": "Alice Smith"
  }
}
DELETE/api/delete/:collection/:id

Delete a document

DELETE /api/delete/users/doc_123
POST/api/query

Query documents with filters

{
  "collection": "users",
  "filter": { "age": { "$gt": 18 } },
  "limit": 10
}