v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Connections

Get connection

Fetch a single connection by ID, including its full non-secret configuration. Credentials (password, OAuth client secret, keypairs) are never returned.

get/api/v1/connections/{id}

Path parameters

idstring uuid required

Connection ID

Example:550e8400-e29b-41d4-a716-446655440000

Connection ID

Response

Connection object

Example response

{
  "connection": {
    "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"
  }
}