Sign in
Connections

Update connection

Update connection settings including base role, environment user attributes, and credentials.

Credential fields:

  • passwordUnencrypted: Update password (all dialects) or service account JSON (BigQuery)
  • privateKey: Add/rotate RSA keypair for Snowflake keypair authentication

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

baseRolestring

Default role to assign to this connection

passwordUnencryptedstring

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

privateKeystring

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

Example request

{
  "baseRole": "QUERIER",
  "environmentUserAttribute": {
    "attributeName": "region",
    "defaultValues": [
      "us-east",
      "us-west"
    ]
  }
}

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
}

Changes