Skip to main content

Data browser and editor

All paths below use https://api.lordbase.com. Read conventions for headers, authentication, pagination and error handling. Values in responses are illustrative; examples show selected fields, not fixed quotas or service guarantees.

Developer tokens authorize only explicitly supported operations. Required scopes appear below; account, billing and token-management operations require a dashboard session. See token permissions.

List tables, collections or keys — GET​

GET /e/v1/developer/databases/{database_id}/tables/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with read_databases (or api). Resource roles and quotas still apply.

Request and permissions: Workspace member. Required query workspace_id UUID matching the database. No body. Engine determines the type of results.

Required path parameters: database_id (UUID).

Response: 200

{
"results": [
{
"name": "example_table",
"size_kb": 8,
"columns_count": 1
}
],
"engine": "postgres"
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Browse stored data — GET​

GET /e/v1/developer/databases/{database_id}/tables/{table_name}/data/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with read_databases (or api). Resource roles and quotas still apply.

Request and permissions: Workspace member. Required query workspace_id matching the database; optional integers limit(default 100) and offset(default 0). URL-encode table_name (table/collection/key). Supply bounded positive pagination; this endpoint does not use the standard100-row cap. Rows/columns differ by engine.

Required path parameters: database_id (UUID); table_name (URL-encoded string).

Response: 200

{
"columns": [
{
"name": "id",
"type": "integer",
"nullable": false
}
],
"rows": [
{
"id": 1
}
],
"total_rows": 1,
"engine": "postgres"
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Modify a PostgreSQL table or row — POST​

POST /e/v1/developer/databases/{database_id}/tables/{table_name}/actions/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with write_databases (or api). Resource roles and quotas still apply.

Request and permissions: Required query workspace_id matching the database. Owners/admins only. Required action: insert_row, update_row, delete_row, rename_table, delete_table, add_column, alter_column or delete_column. Insert/update use values containing strings or null; update/delete require the current row_id returned by the data browser. Rename uses name; column actions use column and, when applicable, name/type/nullable. A stale row returns 409. Insert returns 201; other successful actions return 200.

Required path parameters: database_id (UUID); table_name (URL-encoded string).

Example JSON body:

{
"action": "insert_row",
"values": {
"name": "Example"
}
}

Response: 201

{
"status": "success"
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Execute a query or editor command — POST​

POST /e/v1/developer/databases/{database_id}/query/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with write_databases (or api). Resource roles and quotas still apply.

Request and permissions: Required query workspace_id UUID matching the database. Required JSON query string. PostgreSQL: SQL text; members execute read-only, owners/admins may mutate. Redis/MongoDB: owners/admins only, query is a JSON-encoded command string, not a nested object. Execution can change real data. Errors can be HTTP 400 with status:error. See editor command fields for every supported Redis/MongoDB payload. Results differ by engine: Redis get returns value; MongoDB find returns rows/columns; writes usually return a message, sometimes inserted_id/inserted_ids.

Required path parameters: database_id (UUID).

Example JSON body:

{
"query": "SELECT 1 AS value"
}

Response: 200

{
"status": "success",
"message": "SELECT 1",
"columns": [
"value"
],
"rows": [
{
"value": 1
}
]
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.