Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Connections

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 passwordUnencrypted to update the password
  • BigQuery: Use passwordUnencrypted to update the service account JSON
  • Snowflake: Use privateKey to update the RSA private key (PEM format, minimum 2048 bits)

At least one field must be provided in the request body.

patch/v1/connections/{connectionId}

Path parameters

connectionIdstring uuid required

Connection ID

Request body

passwordUnencryptedstring

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
privateKeystring

Only applicable to Snowflake connections. RSA private key in PEM format for Snowflake connections. Must be at least 2048 bits.

baseRolestring

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

Example request

{
  "passwordUnencrypted": "new-password-here",
  "privateKey": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBg..."
}

Response

Connection updated successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Updated connection credentials."
}