Skip to main content

API URLs

Each database is namespaced by url:

{DATABASE_SUBDOMAIN}.{DATABASE_ENVIRONMENT}.{DATABASE_COMPUTE_PROVIDER}.ekodb.net

URL Structure​

Example URLs:

myapp.production.google.ekodb.net
testdb.staging.google.ekodb.net
dev-db.development.google.ekodb.net

Components​

  • {DATABASE_SUBDOMAIN} - Your unique database identifier
  • {DATABASE_ENVIRONMENT} - Environment type (production, staging, development)
  • {DATABASE_COMPUTE_PROVIDER} - Cloud provider (google, azure, aws, etc.)
  • ekodb.net - ekoDB domain

Supported Protocols​

Providers will vary based on availability of the region and other factors.

✅ Supported (Secure Only)​

  • HTTPS - https://your-db.production.google.ekodb.net
  • WSS - wss://your-db.production.google.ekodb.net

❌ Not Supported​

  • HTTP, FTP, TCP, UDP, and other insecure protocols

Authentication​

Every connection requires a valid JWT token provided by ekoDB.

Exception: The only open API is /api/health. All other APIs are protected by authentication.

Getting Your API URL​

  1. Deploy a database via app.ekodb.io
  2. Find your URL in the database dashboard
  3. Generate API key for authentication
  4. Connect using your preferred client library or REST API

Example Connection​

# Base URL
BASE_URL="https://myapp.production.google.ekodb.net"

# Health check (no auth required)
curl $BASE_URL/api/health

# Authenticated request
curl -H "Authorization: Bearer YOUR_JWT_TOKEN" \
     $BASE_URL/api/collections

Regional Availability​

Database URLs are assigned based on:

  • Region selection during deployment
  • Provider availability in that region
  • Resource optimization for performance

For questions about URL structure or regional availability, contact support@ekodb.io.