Skip to content
HeliosDB HeliosDB Full

REST API Documentation

REST API Documentation

This directory contains detailed REST API endpoint documentation for HeliosDB.

API Endpoints

Query Endpoints

  • POST /api/v1/query - Execute SQL query
  • POST /api/v1/query/explain - Explain query plan
  • POST /api/v1/query/async - Execute async query

Database Management

  • GET /api/v1/databases - List databases
  • POST /api/v1/databases - Create database
  • DELETE /api/v1/databases/{name} - Drop database

Table Operations

  • GET /api/v1/tables - List tables
  • POST /api/v1/tables - Create table
  • GET /api/v1/tables/{name} - Get table info
  • DELETE /api/v1/tables/{name} - Drop table
  • POST /api/v1/vector/search - Semantic search
  • POST /api/v1/vector/index - Create vector index
  • POST /api/v1/vector/insert - Insert vectors

Health & Status

  • GET /api/v1/health - Health check
  • GET /api/v1/status - System status
  • GET /api/v1/metrics - Prometheus metrics

Admin Operations

  • POST /api/v1/admin/backup - Create backup
  • POST /api/v1/admin/restore - Restore backup
  • GET /api/v1/admin/config - Get configuration

Authentication

See AUTHENTICATION.md for details on:

  • JWT token authentication
  • API key authentication
  • mTLS certificate authentication

Rate Limiting

Default limits:

  • 1000 requests/minute for queries
  • 100 requests/minute for admin operations
  • 10 requests/minute for backup/restore

Error Handling

All errors follow the standard format:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable message",
    "details": {}
  }
}

Examples

See the parent API_REFERENCE.md for comprehensive examples.