Skip to main content

Your first HTTP API call

Start with the public reachability check. You need curl; no account or token is required for this request. Windows examples use Command Prompt (CMD).

curl -i "https://api.lordbase.com/e/v1/health/"

Expected HTTP status: 200. Example body:

{"status":"healthy","service":"s0012","version":"1.0.0"}

This proves that the API responded. It does not validate your plan, workspace, token, database credentials or database connectivity.

Before your first protected request​

Protected endpoints require account authentication, an active Lordbase subscription and resource permissions. The token header is Authorization: Bearer YOUR_DEVELOPER_TOKEN.

The workspace-list request needs read_workspaces (or api). Token creation and rotation happen in the signed-in dashboard. Your script does not need a session cookie.

Create an expiring token with read_workspaces in dashboard Settings. Replace YOUR_DEVELOPER_TOKEN with its value, then run:

curl -i "https://api.lordbase.com/e/v1/developer/workspaces/" \
  -H "Authorization: Bearer YOUR_DEVELOPER_TOKEN" \
  -H "Accept: application/json"

A successful response is an object with two arrays, not a bare list:

{"owned_workspaces":[],"member_workspaces":[]}

An empty response means the authenticated account currently has no visible workspaces. If this request fails, record the HTTP status, response body and X-Request-ID, then follow API error diagnosis. See token scopes for permissions and dashboard setup for native database connections.