Skip to main content

Lordbase API reference

The management API root is https://api.lordbase.com/e/v1. This reference covers the public management operations. It includes required authentication, path/query/body inputs, permissions and example responses.

Each operation specifies whether developer tokens are accepted and which scopes it requires. Account, billing and token-management operations use the dashboard session. See token permissions.

Start with conventions, your first API call, and data shapes.

API areaOperations
Service, account and plansPublic health, current account, plan status/limits, cache refresh
Workspaces and collaboratorsWorkspaces, members, invitation records/cancel, developer search
DatabasesProvision, inspect, update, delete, pause, resume, PostgreSQL clone, connection details
Database usersCreate, inspect, edit, delete and reset passwords
BackupsList, create, inspect, delete, start restore and poll restore status
Backup schedulesCreate, inspect, edit, delete and trigger
MetricsCurrent metrics, history and database health
EditorBrowse tables/collections/keys and run supported commands
PoolingPostgreSQL pool status, clients, servers and service health
ExtensionsPostgreSQL catalogue, enable and disable
Query analyticsPostgreSQL summary, query statistics, slow/active queries and reset
AuditDatabase management/editor audit events
TokensCreate, inspect and revoke developer tokens

A machine-readable endpoint inventory maps method/path pairs to reference pages and anchors. It is an index, not an OpenAPI schema or a guarantee of hosted feature availability. Examples use placeholders and selected response fields; replace IDs and settings with real values from your account.