Skip to main content
POST
Run a read-only discovery query against an external data connection.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Api-key
string | null

Path Parameters

connection_id
string<uuid>
required

Body

application/json
operation
enum<string> | null

Discovery operation to run against the connection. Existing SQL callers can omit this when query is provided.

Available options:
query,
schema,
list,
sample
query
string | null
Minimum string length: 1
limit
integer
default:100
Required range: 1 <= x <= 500
parameters
Parameters · object

Response

Successful Response

connection
ConnectionRead · object
required
columns
string[]
required
rows
Rows · object[]
required
row_count
integer
required
truncated
boolean
required
operation
enum<string>
default:query
Available options:
query,
schema,
list,
sample
metadata
Metadata · object