AxioDB Logo
AxioDB Docs

HTTP Server API Reference

RESTful API documentation for AxioDB GUI Server

The AxioDB GUI Server provides a comprehensive RESTful API for managing databases, collections, and documents over HTTP. All endpoints return JSON responses and support standard HTTP status codes. Base URL: http://localhost:27018

Every endpoint below except /api/info, /api/health, /api/routes, and /api/auth/login requires an authenticated session (see the Authentication & Access Control section below) and is subject to role-based permission checks - expect 401 without a valid session cookie and 403 if the caller's role lacks the required permission.

Base URL

http://localhost:27018

Content-Type

application/json

Authentication

Session cookie (httpOnly) via /api/auth/login, RBAC-enforced

⚠️ Error Response Format

All error responses follow this consistent format:

{
  "statusCode": 400,
  "status": "error",
  "message": "Detailed error message",
  "error": {
    // Additional error details (optional)
  }
}

💡 Usage Tips

  • ✓Set Content-Type: application/json for all requests
  • ✓Use pagination for large datasets (10 items per page)
  • ✓Check status codes for proper error handling
  • ✓Use documentId queries for fastest lookups
  • ✓Enable encryption when creating sensitive collections
  • ✓Export databases regularly for backups

ℹ️The AxioDB GUI Server runs on localhost:27018 by default. All API endpoints are available when GUI is enabled in AxioDB initialization. For more details on the JavaScript/TypeScript API, see the Core API Reference.