Skip to main content

Quickstart: Any Language

Integrate Lordbase from any programming language using standard HTTP requests.

Prerequisites​

API Base URL​

https://api.lordbase.com/e/v1

Authentication​

All API requests require authentication. Use either:

  1. Session Cookie — Automatic when using the Dashboard
  2. Developer Access Token — For programmatic/API access
# Using Developer Access Token
curl -H "Authorization: Bearer lb_pat_..." \
     https://api.lordbase.com/e/v1/developer/workspaces/

Step 1: List Your Workspaces​

curl -X GET https://api.lordbase.com/e/v1/developer/workspaces/ \
  -H "Authorization: Bearer lb_pat_your_token"

Response:

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My Project",
    "description": "",
    "database_count": 0,
    "member_count": 1,
    "created_at": "2026-01-15T10:30:00Z"
  }
]

Step 2: Create a Database​

curl -X POST https://api.lordbase.com/e/v1/developer/workspaces/{workspace_id}/databases/ \
  -H "Authorization: Bearer lb_pat_your_token" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "my-app-db",
    "engine": "postgres"
  }'

Supported engines: postgres, redis, mongodb

Response:

{
  "id": "660e8400-e29b-41d4-a716-446655440001",
  "display_name": "my-app-db",
  "db_name": "lb_a1b2c3d4e5f6",
  "engine": "postgres",
  "host": "api.lordbase.com",
  "port": 6432,
  "status": "creating",
  "max_storage_mb": 1024,
  "max_connections": 20,
  "created_at": "2026-01-15T10:35:00Z"
}

Step 3: Get Connection Details​

curl -X GET https://api.lordbase.com/e/v1/developer/databases/{database_id}/connection/ \
  -H "Authorization: Bearer lb_pat_your_token"

Response:

{
  "host": "api.lordbase.com",
  "port": 6432,
  "database": "lb_a1b2c3d4e5f6",
  "username": "admin_12345678",
  "password": "generated-secure-password",
  "connection_string": "postgresql://admin_12345678:[email protected]:6432/lb_a1b2c3d4e5f6",
  "ssl_mode": "prefer"
}

Step 4: Connect to Your Database​

Python (psycopg2)​

import psycopg2

conn = psycopg2.connect(
    host="api.lordbase.com",
    port=6432,
    dbname="lb_a1b2c3d4e5f6",
    user="admin_12345678",
    password="generated-secure-password"
)

cursor = conn.cursor()
cursor.execute("SELECT version();")
print(cursor.fetchone())

Node.js (pg)​

const { Pool } = require('pg');

const pool = new Pool({
  connectionString: 'postgresql://admin_12345678:[email protected]:6432/lb_a1b2c3d4e5f6'
});

const result = await pool.query('SELECT version()');
console.log(result.rows[0]);

Go​

import "database/sql"
import _ "github.com/lib/pq"

db, err := sql.Open("postgres",
    "postgres://admin_12345678:[email protected]:6432/lb_a1b2c3d4e5f6?sslmode=prefer")

Redis (Python)​

import redis

r = redis.Redis(
    host='api.lordbase.com',
    port=6379,
    username='admin_12345678',
    password='generated-secure-password'
)
r.set('hello', 'world')
print(r.get('hello'))

MongoDB (Python)​

from pymongo import MongoClient

client = MongoClient('mongodb://admin_12345678:[email protected]:27017/lb_a1b2c3d4e5f6')
db = client['lb_a1b2c3d4e5f6']
db.test.insert_one({"hello": "world"})

Step 5: Create a Backup​

curl -X POST https://api.lordbase.com/e/v1/developer/databases/{database_id}/backups/ \
  -H "Authorization: Bearer lb_pat_your_token" \
  -H "Content-Type: application/json" \
  -d '{"name": "pre-migration-backup"}'

Step 6: Monitor Your Database​

# Get current metrics
curl -X GET https://api.lordbase.com/e/v1/developer/databases/{database_id}/metrics/ \
  -H "Authorization: Bearer lb_pat_your_token"

# Get health check
curl -X GET https://api.lordbase.com/e/v1/developer/databases/{database_id}/health/ \
  -H "Authorization: Bearer lb_pat_your_token"

Next Steps​