---
title: "List connections"
method: GET
path: "/connections"
tags: ["Connections"]
---

# List connections

`GET /connections`

## Request

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

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.

## Response `200`

Connections

- Connection[]
  - `id` string
  - `name` string
  - `type` 'postgres' | 'mysql' | 'mssql' | 'redshift' | 'clickhouse' | 'dynamodb' | 'bigquery'
  - `host` string
  - `port` integer
  - `database` string
  - `username` string
  - `sslEnabled` boolean
  - `readOnly` boolean: When true, writes are blocked at the driver level.
  - `status` string
  - `isShared` boolean: Visible to the whole company.

## Other responses

- `401`: Bad or missing credentials

---

[API](https://skmtc.dev/saturnsql/apis/saturnsql-api.md) · [All operations](https://skmtc.dev/saturnsql/apis/saturnsql-api/llms.txt) · [OpenAPI document](https://skmtc.dev/saturnsql/apis/saturnsql-api/revisions/90a3e54ad115?raw)