v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Connections

Update connection

Update connection settings, including the non-secret configuration fields returned by GET, plus base role, environment user attributes, and credentials. Round-trips with GET so a connection can be managed as code. dialect cannot be changed.

Credential fields (write-only, never returned):

passwordUnencrypted: Update password (all dialects) or service account JSON (BigQuery)
privateKey: Add/rotate RSA keypair for Snowflake keypair authentication
oauthClientSecretUnencrypted: Update OAuth client secret (Snowflake, Databricks)

Changing host or port is subject to the same SSH tunnel and PrivateLink restrictions as connection create: you may only point a connection at an SSH tunnel already provisioned for your organization, and a PrivateLink host must belong to your organization. Requests that violate this return 400.

Note: Credentials are encrypted at rest and never returned in API responses.

patch/api/v1/connections/{id}

Path parameters

idstring uuid required

Connection ID

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

Connection ID

Request body

acceptsLicenseboolean

Acceptance of the license terms (Oracle)

allowsUserSpecificTimezonesboolean

Whether users may specify their own timezones

alwaysScopeViewNamesboolean

Whether generated view names always include catalog/schema scoping

authenticationTypestring

Authentication type. Dialect-specific; known values are aws-access-key, aws-cross-account-role, databricks-oauth-m2m, databricks-personal-access-token, databricks-oauth-user, mssql-sql-authentication, mssql-active-directory-password, mssql-active-directory-service-principal, snowflake-oauth-user, snowflake-external-oauth-user, snowflake-password, snowflake-keypair, bigquery-oauth-user, bigquery-byo-oauth-user, bigquery-service-account, bigquery-workload-identity-federation.

awsRoleArnstring

AWS IAM role ARN (Athena)

baseRolestring

Default role to assign to this connection

databasestring

Database/catalog name (project ID for BigQuery)

defaultSchemastring

Default schema for the connection

enableDbSemanticLayerIntegrationboolean

Enable the dialect-native semantic layer integration (Snowflake, Databricks)

enableDbSemanticLayerTopicsboolean

Enable dialect-native semantic layer topics (Snowflake, Databricks)

externalOauthAudiencestring

External OAuth audience claim (Snowflake)

externalOauthAuthorizationUrlstring uri

External OAuth authorization URL, HTTPS (Snowflake)

externalOauthTokenUrlstring uri

External OAuth token URL, HTTPS (Snowflake)

hoststring

Hostname or IP of the database server (account identifier for Snowflake)

hostOverridestring

Custom Snowflake host, overriding the account identifier

inferRelationshipsFromColumnNamesboolean

Infer relationships from column-name conventions

inferRelationshipsFromForeignKeysboolean

Infer relationships from declared foreign keys

maxBillingBytesstring

Maximum bytes billed for a query (BigQuery)

namestring

Connection display name

oauthClientIdstring

OAuth client ID for admin schema refresh (Snowflake, Databricks)

oauthClientSecretUnencryptedstring

OAuth client secret for admin schema refresh (Snowflake, Databricks). Write-only; never returned.

passwordUnencryptedstring

New password or service account key. For BigQuery, this must be the JSON service account key file content.

portinteger

Port number for the database connection

privateKeystring

RSA private key for keypair authentication (Snowflake only). Must be PEM-encoded PKCS#8 format, minimum 2048-bit.

queryTimeoutSecondsinteger

Query timeout in seconds (max 3600)

queryTimezonestring

Timezone used for query results

regionstring

Region (BigQuery, Athena)

scratchSchemastring

Schema used for data input (upload) tables

systemTimezonestring

Timezone of the database

trustServerCertificateboolean

Whether to trust the server certificate

useMachineAuthboolean

Authenticate using machine (M2M OAuth) credentials

usernamestring

Username to authenticate with (client email for BigQuery service accounts)

warehousestring

Warehouse (Snowflake) or HTTP path (Databricks)

Example request

{
  "acceptsLicense": true,
  "alwaysScopeViewNames": true,
  "authenticationType": "snowflake-password",
  "awsRoleArn": "arn:aws:iam::123456789012:role/OmniAthenaRole",
  "baseRole": "QUERIER",
  "database": "analytics_db",
  "defaultSchema": "public",
  "environmentUserAttribute": {
    "attributeName": "region",
    "defaultValues": [
      "us-east",
      "us-west"
    ]
  },
  "externalOauthAuthorizationUrl": "https://oauth.example.com/authorize",
  "externalOauthTokenUrl": "https://oauth.example.com/token",
  "host": "myaccount",
  "hostOverride": "myaccount.snowflakecomputing.com",
  "inferRelationshipsFromColumnNames": true,
  "maxBillingBytes": "1000000000",
  "name": "Production Snowflake",
  "port": 5432,
  "queryTimeoutSeconds": 900,
  "queryTimezone": "NONE",
  "region": "us-east-1",
  "scratchSchema": "omni_scratch",
  "systemTimezone": "UTC",
  "username": "analytics_user",
  "warehouse": "COMPUTE_WH"
}

Response

Connection updated successfully

messagestring required

Status message describing what was updated

successboolean required

Whether the operation succeeded

Example response

{
  "message": "Updated connection default role.",
  "success": true
}