Need help? Get answers from the docs with Omni's in-app AI! Log in to your Omni instance and open the Omni Agent in the sidebar.
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."
}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 (PEM format, minimum 2048 bits)
At least one field must be provided in the request body.
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."
}Documentation Index
Fetch the complete documentation index at: https://docs.omni.co/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
Connection ID
Body
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
"new-password-here"
Only applicable to Snowflake connections. RSA private key in PEM format for Snowflake connections. Must be at least 2048 bits.
"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBg..."
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
Configuration for environment user attributes. Set to null to remove environment user attribute settings.
Show child attributes
Show child attributes
Was this page helpful?