Home/Documentation

API Reference

Complete reference for the jsondb.cloud REST API (v1).

Base URL

https://api.jsondb.cloud/v1/db

Authentication

All requests require an API key in the Authorization header:

Authorization: Bearer jdb_sk_live_...

All Endpoints

MethodPathDescription
POST/v1/db/{ns}/{collection}Create a document
GET/v1/db/{ns}/{collection}/{id}Get a document
PUT/v1/db/{ns}/{collection}/{id}Replace a document
PATCH/v1/db/{ns}/{collection}/{id}Partial update (merge or JSON Patch)
DELETE/v1/db/{ns}/{collection}/{id}Delete a document
GET/v1/db/{ns}/{collection}List & query documents
POST/v1/db/{ns}/{collection}/_bulkBulk operations
PUT/v1/db/{ns}/{collection}/_schemaSet collection schema
GET/v1/db/{ns}/{collection}/_schemaGet collection schema
POST/v1/db/{ns}/{collection}/_validateDry-run schema validation
POST/v1/db/{ns}/{collection}/_webhooksRegister webhook
GET/v1/db/{ns}/{collection}/_webhooksList webhooks
GET/v1/db/{ns}/{collection}/{id}/versionsList document versions
POST/v1/db/{ns}/{collection}/{id}/versions/{v}/restoreRestore to version
POST/v1/db/{ns}/{collection}/_importBulk import (JSON/CSV/NDJSON)
GET/v1/db/{ns}/{collection}/_exportExport collection