API Reference
pREST API reference — REST (Representational State Transfer) HTTP endpoints that map to SQL on the native PostgreSQL adapter (and certified engines).
Last updated
pREST API reference — REST (Representational State Transfer) HTTP endpoints that map to SQL on the native PostgreSQL adapter (and certified engines).
pREST generates HTTP APIs from your database catalog. Today the native dialect is PostgreSQL (and Postgres-compatible engines documented under Databases). This reference covers endpoints, parameters, auth, and advanced query patterns.
REST (Representational State Transfer) is an architectural style for building APIs over HTTP. pREST exposes your SQL tables as REST resources at /{database}/{schema}/{table}, mapping standard verbs to CRUD on the same server as MCP.
Application backends, mobile and web clients, and any HTTP client that needs CRUD on SQL tables use that surface. This reference documents the endpoints below; see also Parameters and Auth.
prestd implements HTTP verbs that map to SQL data operations on the connected engine.
SQL
SELECT(PostgreSQL dialect mapping)
/_health
Liveness probe — pings default database
/_ready
Readiness probe — pings default database and all registered aliases
/_mcp
MCP discovery — server metadata and available read-only tools (guide, stdio adapter)
/databases
List all databases
/schemas
List all schemas
/tables
List all tables
/show/{DATABASE}/{SCHEMA}/{TABLE}
Lists table structure - all fields contained in the table
/{DATABASE}/{SCHEMA}
Lists table tables - find by schema
/{DATABASE}/{SCHEMA}/{TABLE}
List all rows, find by database, schema and table
/{DATABASE}/{SCHEMA}/{VIEW}
List all rows, find by database, schema and view
/_mcp
MCP JSON-RPC — initialize, tools/list, tools/call (guide, stdio adapter)
SQL
INSERT(PostgreSQL dialect mapping)
JSON DATA:
SQL
UPDATE(PostgreSQL dialect mapping)
Using query string to make filter (WHERE), example:
JSON DATA:
unconditional
updatecan update unwanted record
SQL
DELETE(PostgreSQL dialect mapping)
Using query string to make filter (WHERE), example:
unconditional
deletecan delete unwanted record
Last updated
/{DATABASE}/{SCHEMA}/{TABLE}{
"FIELD1": "string value",
"FIELD2": 1234567890
}/{DATABASE}/{SCHEMA}/{TABLE}?{FIELD NAME}={VALUE}{
"FIELD1": "string value",
"FIELD2": 1234567890,
"ARRAYFIELD": ["value 1","value 2"]
}/{DATABASE}/{SCHEMA}/{TABLE}?{FIELD NAME}={VALUE}