Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
dbType
enum<string>

Database Type

Available options:
postgresql,
mysql,
mariadb,
mongodb,
redis,
mssql,
sqlite
connectionMode
enum<string>

Connection Type

Available options:
tcp,
socket
host
string

Host

socketPath
string

Socket Path

port
number

Port

Required range: 1 <= x <= 65535
mongoSrv
boolean

Use SRV connection (mongodb+srv://)

database
string

Database Name

filePath
string

Database File Path

username
string

Username

password
string

Password

ssl
boolean

Use SSL/TLS

extraParams
string

Additional Parameters

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.