Connections

List connections

Lists the database connections available to the caller (own + company-shared). Use an id as the connectionId for schema and query calls. Available to API keys with the read scope.

get/connections

Request

  • Base URL: https://saturnsql.com/api
  • URL: https://saturnsql.com/api/connections
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Response

Connections

idstring
namestring
type'postgres' | 'mysql' | 'mssql' | 'redshift' | 'clickhouse' | 'dynamodb' | 'bigquery'
hoststring
portinteger
databasestring
usernamestring
sslEnabledboolean
readOnlyboolean

When true, writes are blocked at the driver level.

statusstring
isSharedboolean

Visible to the whole company.

Changes

No recorded changes to this operation across all 1 revision of this API.