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."
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

Connection APIs

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 (PKCS#8 or PKCS#1 PEM format, minimum 2048 bits). Omni converts a PKCS#1 key to PKCS#8.

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

PATCH

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."
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

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. Unencrypted RSA private key for Snowflake connections, in PKCS#8 or PKCS#1 PEM format. Must be at least 2048 bits. Omni converts a PKCS#1 key to PKCS#8.

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 | null

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

Show child attributes

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.

Response

Connection updated successfully

success

boolean

Example:

true

message

string

Example:

"Updated connection credentials."

Getting started

Who am I?

Administration APIs

AI APIs

App APIs

Branch APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Embed APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Update connection

Authorizations

Path Parameters

Body

Response