v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Connections

List connections

get/api/v1/connections

Query parameters

databasestring

Filter by database name (case-insensitive contains)

Example:analytics

Filter by database name (case-insensitive contains)

dialectstring

Filter by dialect(s). Comma-separated list for multiple values

Example:snowflake,bigquery

Filter by dialect(s). Comma-separated list for multiple values

includeDeletedboolean

Include soft-deleted connections in results

namestring

Filter by connection name (case-insensitive contains)

Example:Production

Filter by connection name (case-insensitive contains)

sortDirection'asc' | 'desc'

Sort direction

Example:desc

Sort direction

sortField'database' | 'dialect' | 'name'

Field to sort by

Example:name

Field to sort by

Response

List of connections

Example response

{
  "connections": [
    {
      "authenticationType": "snowflake-password",
      "baseRole": "QUERIER",
      "createdAt": "2024-01-15T10:30:00Z",
      "database": "analytics_db",
      "defaultSchema": "public",
      "dialect": "snowflake",
      "host": "myaccount",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "includeSchemas": [
        "public",
        "analytics"
      ],
      "inferRelationshipsFromColumnNames": true,
      "name": "Production Snowflake",
      "port": 5432,
      "queryTimeoutSeconds": 900,
      "updatedAt": "2024-01-15T10:30:00Z",
      "username": "analytics_user",
      "warehouse": "COMPUTE_WH"
    }
  ]
}