OMomniapp
Connections

Update dbt configuration

Changed on
put/api/v1/connections/{connectionId}/dbt

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/connections/{connectionId}/dbt
  • Auth
    HTTP bearer

Path parameters

connectionIdstring uuid required

Connection ID

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

Request body

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

Authentication method for the git repository: "ssh" (deploy key), "https_token" (deploy token or PAT), or "github_app" (GitHub App installation, github.com only). Omit to keep the connected repository's method (SSH for a first-time setup).

autogenRelationshipsboolean required

Automatically generate relationships from dbt

branchstring required

Git branch name

commitSigningCommitterEmailstring email

Verified email of the GitHub user that owns the registered signing key (github_app auth only). Omit to leave the stored value unchanged. Must be set together with commitSigningCommitterName.

commitSigningCommitterNamestring

Display name written into signed commits (github_app auth only). Omit to leave the stored value unchanged. Must be set together with commitSigningCommitterEmail.

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

dbt version to use. Auto and null both let Omni choose; null is the default, so omitting the field resets the version to Auto. A version the connection's dialect cannot run is rejected: 1.12 on Databricks and ClickHouse; 2.0 on Trino, Athena, and StarRocks.

enableSemanticLayerboolean

Enable dbt semantic layer integration

enableVirtualSchemasboolean required

Enable virtual schemas from dbt

githubAppInstallationIdstring

Numeric GitHub App installation ID. Required when connecting a repository with authMethod "github_app"; may be omitted on updates that keep the connected repository.

rotateKeysboolean

Rotate SSH deploy keys (ssh auth only)

sshUrlstring required

Clone URL for the git repository — SSH (git@...) for ssh auth, https:// for https_token or github_app auth

tokenstring

HTTPS access token (deploy token value, PAT, etc.). Required when connecting a repository with authMethod "https_token"; omit on updates that keep the stored token.

Example request

{
  "authMethod": "ssh",
  "autogenRelationships": true,
  "branch": "main",
  "commitSigningCommitterEmail": "omni-bot@example.com",
  "commitSigningCommitterName": "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' required

Authentication method for the git repository. "ssh" for deploy key, "https_token" for deploy token/PAT, "github_app" for a GitHub App installation.

autogenRelationshipsboolean required

Whether relationships are auto-generated from dbt

branchstring required

Git branch name

commitSigningCommitterEmailstring nullable required

Verified email of the GitHub user that owns the registered signing key. Null unless a commit signer is configured (github_app auth only).

commitSigningCommitterNamestring nullable required

Display name written into signed commits. Null unless a commit signer is configured (github_app auth only).

commitSigningPublicKeystring nullable required

SSH public key to register as a signing key on the GitHub user that owns commitSigningCommitterEmail, so commits show as Verified. Null for non-github_app auth.

dbtVersionstring required

dbt version being used

enableSemanticLayerboolean required

Whether the dbt semantic layer integration is enabled

enableVirtualSchemasboolean required

Whether virtual schemas are enabled

githubAppInstallationIdstring nullable required

GitHub App installation ID. Null for non-github_app auth.

projectRootPathstring nullable required

Path to dbt project root

publicKeystring nullable required

SSH public key to register as a deploy key on the git repository. Reflects the new key after a PUT with rotateKeys: true. Null for non-ssh auth.

sshUrlstring required

Clone URL for the git repository — SSH (git@...) for ssh auth, https:// for https_token or github_app auth

supportsDbttrue required

Indicates dbt is supported and configured

Example response

{
  "authMethod": "ssh",
  "autogenRelationships": true,
  "branch": "main",
  "commitSigningCommitterEmail": "omni-bot@example.com",
  "commitSigningCommitterName": "Omni Bot",
  "dbtVersion": "Auto",
  "githubAppInstallationId": "12345678",
  "projectRootPath": "dbt_project",
  "publicKey": "ssh-rsa AAAA...",
  "sshUrl": "git@github.com:org/repo.git",
  "supportsDbt": true
}

Changes

  • 8a7600b8087eRevision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      added the new 1.11 enum value to the 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 Auto enum value to the request property

    • info

      added the new undefined enum value to the request property

  • 934e72bd3040Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status