Update connection
Update connection properties including credentials. Credentials are encrypted at rest and never returned in API responses.
This endpoint supports credential rotation for infrastructure-as-code workflows. Depending on the connection type, you can update:
- Password-based connections (Postgres, MySQL, etc.): Use
passwordUnencryptedto update the password - BigQuery: Use
passwordUnencryptedto update the service account JSON - Snowflake: Use
privateKeyto update the RSA private key (PKCS#8 or PKCS#1 PEM format, minimum 2048 bits, at most 64 KB). Omni converts a PKCS#1 key to PKCS#8. IfprivateKeyis encrypted, also provideprivateKeyPassphraseso Omni can decrypt it.
At least one field must be provided in the request body.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Body
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.
"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBg..."
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.
1024"my-secure-passphrase"
The default role for users accessing the connection. Available roles include:
VIEWER- Can view the modelQUERIER- Can view and query the modelQUERY_TOPICS- Can query specific topics. Equivalent to Restricted Querier.MODELER- Can edit and model the dataCONNECTION_ADMIN- Full administrative access to the connectionNO_ACCESS- No access to the model- Custom roles defined for your organization
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.
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.

