Skip to main content
PATCH
/
v1
/
connections
/
{connectionId}
curl --request PATCH \
  --url https://{instance}.omniapp.co/api/v1/connections/{connectionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "passwordUnencrypted": "new-password-here"
}
'
{
  "success": true,
  "message": "Updated connection credentials."
}

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 in PEM format for Snowflake connections. Must be at least 2048 bits.

Example:

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

​
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

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

Response

Connection updated successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Updated connection credentials."