Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

connectionId
string<uuid>
required

Connection ID

Body

application/json
passwordUnencrypted
string

Password or service account JSON for credential rotation.

  • For password-based connections such as Postgres, MySQL, etc. - Provide the new password as a string
  • For BigQuery - Provide the entire service account JSON file as a string
Example:

"new-password-here"

privateKey
string

Only applicable to Snowflake connections. RSA private key for Snowflake connections, in PKCS#8 or PKCS#1 PEM format. Must be at least 2048 bits, at most 64 KB. Omni converts a PKCS#1 key to PKCS#8. An encrypted key requires privateKeyPassphrase.

Example:

"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBg..."

privateKeyPassphrase
string

Only applicable to Snowflake connections. Passphrase for privateKey when it's encrypted. The key must use PBKDF2 at 1,000,000 iterations or fewer (OpenSSL's own default is 2,048). Omni uses the passphrase once to decrypt the key, then stores the key under its own encryption at rest; the passphrase itself isn't retained.

Maximum string length: 1024
Example:

"my-secure-passphrase"

baseRole
string

The default role for users accessing the connection. Available roles include:

  • VIEWER - Can view the model
  • QUERIER - Can view and query the model
  • QUERY_TOPICS - Can query specific topics. Equivalent to Restricted Querier.
  • MODELER - Can edit and model the data
  • CONNECTION_ADMIN - Full administrative access to the connection
  • NO_ACCESS - No access to the model
  • Custom roles defined for your organization
environmentUserAttribute
object | null

Configuration for environment user attributes. Set to null to remove environment user attribute settings.

useReadScaling
boolean

Applicable for MSSQL only. Whether to request read-only routing (ApplicationIntent=ReadOnly) for the connection, so read queries can run on a readable secondary.

SQL Server uses the primary when no readable secondary is available. Omni's own upload writes always use the primary, even when this setting is on.

strictEncryption
boolean

Applicable for MSSQL only, not Fabric. Whether to use strict encryption (encrypt=strict, TDS 8.0) for the connection. The connection starts with TLS and always validates the server certificate, which overrides trustServerCertificate.

Requires a TDS 8.0 endpoint: SQL Server 2022 or later, or Azure SQL.

Response

Connection updated successfully

success
boolean
Example:

true

message
string
Example:

"Updated connection credentials."