OMomni
dbt

Update dbt configuration

Changed on
<Note> **Connection Admin** permissions are required to use this endpoint. </Note>

Update the dbt configuration for the specified connection.

put/v1/connections/{connectionId}/dbt

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/connections/{connectionId}/dbt
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

connectionIdstring uuid required

ID of the connection where dbt is configured

Example:550e8400-e29b-41d4-a716-446655440000

Request body

authMethod'ssh' | 'https_token' | 'github_app'

The authentication method to use for git operations:

  • ssh - Deploy key
  • https_token - Deploy token/PAT
  • github_app - GitHub App installation (github.com only)

When omitted, the existing auth method is retained. Field/method compatibility is validated against the effective auth method (the request's authMethod, or the connected repo's if omitted).

autogenRelationshipsboolean required

Automatically generate relationships from dbt

branchstring required

Git branch name

committerEmailstring

Required when authMethod: github_app and commit signing is enabled. Email address used for commit signing. Must match the email the signing key is registered against in GitHub. When blank on an update, preserves the existing committer email rather than clearing it.

committerNamestring

Required when authMethod: github_app and commit signing is enabled. Name used for commit signing. When blank on an update, preserves the existing committer name rather than clearing it.

dbtVersion'Auto' | '1.11' | '1.12' | '2.0' | 'null' nullable

dbt version to use. Both Auto and null let Omni choose the version; null is the default, so omitting this field resets the version to Auto.

A version the connection's dialect can't run is rejected:

  • 1.12 - Not supported on Databricks or ClickHouse
  • 2.0 - Not supported on Trino, Athena, or StarRocks
enableSemanticLayerboolean

Enable dbt semantic layer integration

enableVirtualSchemasboolean required

Enable virtual schemas from dbt

githubAppInstallationIdstring

Required when authMethod: github_app. GitHub App installation ID (numeric). Updates without an installation ID keep the existing repo config for metadata-only saves, but changing the URL or switching auth methods without one is rejected.

rotateKeysboolean

Rotate SSH deploy keys. Only applicable when authMethod: ssh.

sshUrlstring required

Git repository URL. Varies depending on the authMethod:

  • ssh - A string starting with git@...
  • https_token - A string starting with https://...
  • github_app - A string starting with https://github.com/...
tokenstring

Required when authMethod: https_token. HTTPS token for authentication (deploy token, PAT, etc.). Write-only; never returned in GET responses.

Example request

{
  "authMethod": "ssh",
  "autogenRelationships": true,
  "branch": "main",
  "committerEmail": "bot@example.com",
  "committerName": "Omni Bot",
  "dbtVersion": "1.11",
  "githubAppInstallationId": "12345678",
  "sshUrl": "git@github.com:org/repo.git"
}

Response

dbt configuration updated successfully

authMethod'ssh' | 'https_token' | 'github_app'

The authentication method used for git operations:

  • ssh - Deploy key
  • https_token - Deploy token/PAT
  • github_app - GitHub App installation
autogenRelationshipsboolean required

Whether relationships are auto-generated from dbt

branchstring required

Git branch name

dbtVersionstring required

dbt version being used

enableSemanticLayerboolean required

Whether the dbt semantic layer integration is enabled

enableVirtualSchemasboolean required

Whether virtual schemas are enabled

projectRootPathstring nullable required

Path to dbt project root

sshUrlstring required

Git repository URL

supportsDbtboolean required

Whether the connection dialect supports dbt

Example response

{
  "authMethod": "ssh",
  "autogenRelationships": true,
  "branch": "main",
  "dbtVersion": "Auto",
  "projectRootPath": "dbt_project",
  "sshUrl": "git@github.com:org/repo.git",
  "supportsDbt": true
}

Changes

  • 43290040f88fRevision changes
    • breaking

      removed the enum value 1.10 of the request property

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new 1.12 enum value to the request property

    • info

      added the new 2.0 enum value to the request property

    • info

      added the new undefined enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status