API Overview

Eden-MDBS provides a REST API for interacting with your database infrastructure. All API endpoints are available at http://{host}:8000/api/v1/.

Base URL

http://{host}:8000/api/v1

Authentication

Most API endpoints require authentication via JWT tokens. See Authentication for details.

Authentication Methods

API Categories

Organization Management

Authentication

Endpoints (Database Connections)

MCP Tooling

Users & IAM

RBAC (Role-Based Access Control)

Templates

Workflows

Request Format

All requests should use JSON format:

curl http://{host}:8000/api/v1/endpoints \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{"key": "value"}'

Response Format

Successful responses return JSON with a status field:

{
  "status": "success",
  "data": { ... }
}

Error responses include error details:

{
  "error": "Error Type",
  "message": "Detailed error message"
}

See Error Responses for complete error code reference.

HTTP Status Codes

Rate Limiting

Eden-MDBS supports configurable rate limiting via the EDEN_RATE_LIMIT environment variable. When rate limiting is enabled, responses include:

• X-RateLimit-Limit: Maximum requests per window
• X-RateLimit-Remaining: Remaining requests in current window
• X-RateLimit-Reset: Time when the rate limit resets

API Documentation

Eden-MDBS provides auto-generated API documentation:

• Swagger UI: http://{host}:8000/swagger-ui/
• OpenAPI JSON: http://{host}:8000/api-docs/openapi.json

Quick Examples

Create Organization

curl http://{host}:8000/api/v1/new \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {EDEN_NEW_ORG_TOKEN}" \
  -d '{
    "id": "my_company",
    "super_admins": [
      {"username": "admin", "password": "secure_password"}
    ]
  }'

Login

curl http://{host}:8000/api/v1/auth/login \
  -u admin:secure_password \
  -X POST

Create Endpoint

curl http://{host}:8000/api/v1/endpoints \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "id": "mydb",
    "kind": "Postgres",
    "config": {
      "write_conn": {
        "url": "postgresql://user:pass@host:5432/db"
      }
    }
  }'

Execute Query

curl http://{host}:8000/api/v1/endpoints/mydb/read \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"query": "SELECT * FROM users LIMIT 10"}'

Next Steps

• Authentication APIs - Login, tokens, and refresh
• Organization APIs - Managing organizations
• Endpoint Management - Database connections
• Query Execution - Running queries
• Error Responses - Error codes and handling