Skip to main content
POST
Run a scoped SQL query or mutation

Authorizations

Authorization
string
header
required

API key passed as a Bearer token. Configure via the apiKeys field in project.json or the POLPO_API_KEY environment variable.

Path Parameters

resource
string
required
Required string length: 1 - 128

Body

application/json
sql
string
required
Required string length: 1 - 65536
params
(string | number | boolean | null)[]
Maximum array length: 1000
Maximum string length: 65536
mode
enum<string>
Available options:
read,
write
maxRows
integer
Required range: 1 <= x <= 200
idempotencyKey
string
Required string length: 1 - 200
Pattern: ^[\x21-\x7e]+$

Response

Success

ok
enum<boolean>
required
Available options:
true
data
object
required