Update dbt configuration

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "autogenRelationships": true,
  "branch": "main",
  "enableVirtualSchemas": false,
  "sshUrl": "git@github.com:org/repo.git",
  "authMethod": "ssh",
  "committerEmail": "bot@example.com",
  "committerName": "Omni Bot",
  "dbtVersion": "1.11",
  "enableSemanticLayer": false,
  "githubAppInstallationId": "12345678",
  "projectRootPath": "dbt_project",
  "rotateKeys": false,
  "token": "<string>"
}
'

import requests

url = "https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt"

payload = {
    "autogenRelationships": True,
    "branch": "main",
    "enableVirtualSchemas": False,
    "sshUrl": "git@github.com:org/repo.git",
    "authMethod": "ssh",
    "committerEmail": "bot@example.com",
    "committerName": "Omni Bot",
    "dbtVersion": "1.11",
    "enableSemanticLayer": False,
    "githubAppInstallationId": "12345678",
    "projectRootPath": "dbt_project",
    "rotateKeys": False,
    "token": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    autogenRelationships: true,
    branch: 'main',
    enableVirtualSchemas: false,
    sshUrl: 'git@github.com:org/repo.git',
    authMethod: 'ssh',
    committerEmail: 'bot@example.com',
    committerName: 'Omni Bot',
    dbtVersion: '1.11',
    enableSemanticLayer: false,
    githubAppInstallationId: '12345678',
    projectRootPath: 'dbt_project',
    rotateKeys: false,
    token: '<string>'
  })
};

fetch('https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'autogenRelationships' => true,
    'branch' => 'main',
    'enableVirtualSchemas' => false,
    'sshUrl' => 'git@github.com:org/repo.git',
    'authMethod' => 'ssh',
    'committerEmail' => 'bot@example.com',
    'committerName' => 'Omni Bot',
    'dbtVersion' => '1.11',
    'enableSemanticLayer' => false,
    'githubAppInstallationId' => '12345678',
    'projectRootPath' => 'dbt_project',
    'rotateKeys' => false,
    'token' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt"

	payload := strings.NewReader("{\n  \"autogenRelationships\": true,\n  \"branch\": \"main\",\n  \"enableVirtualSchemas\": false,\n  \"sshUrl\": \"git@github.com:org/repo.git\",\n  \"authMethod\": \"ssh\",\n  \"committerEmail\": \"bot@example.com\",\n  \"committerName\": \"Omni Bot\",\n  \"dbtVersion\": \"1.11\",\n  \"enableSemanticLayer\": false,\n  \"githubAppInstallationId\": \"12345678\",\n  \"projectRootPath\": \"dbt_project\",\n  \"rotateKeys\": false,\n  \"token\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"autogenRelationships\": true,\n  \"branch\": \"main\",\n  \"enableVirtualSchemas\": false,\n  \"sshUrl\": \"git@github.com:org/repo.git\",\n  \"authMethod\": \"ssh\",\n  \"committerEmail\": \"bot@example.com\",\n  \"committerName\": \"Omni Bot\",\n  \"dbtVersion\": \"1.11\",\n  \"enableSemanticLayer\": false,\n  \"githubAppInstallationId\": \"12345678\",\n  \"projectRootPath\": \"dbt_project\",\n  \"rotateKeys\": false,\n  \"token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"autogenRelationships\": true,\n  \"branch\": \"main\",\n  \"enableVirtualSchemas\": false,\n  \"sshUrl\": \"git@github.com:org/repo.git\",\n  \"authMethod\": \"ssh\",\n  \"committerEmail\": \"bot@example.com\",\n  \"committerName\": \"Omni Bot\",\n  \"dbtVersion\": \"1.11\",\n  \"enableSemanticLayer\": false,\n  \"githubAppInstallationId\": \"12345678\",\n  \"projectRootPath\": \"dbt_project\",\n  \"rotateKeys\": false,\n  \"token\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "autogenRelationships": true,
  "branch": "main",
  "dbtVersion": "Auto",
  "enableSemanticLayer": false,
  "enableVirtualSchemas": false,
  "projectRootPath": "dbt_project",
  "sshUrl": "git@github.com:org/repo.git",
  "supportsDbt": true,
  "authMethod": "ssh",
  "committerEmail": "bot@example.com",
  "committerName": "Omni Bot",
  "commitSigningPublicKey": "ssh-ed25519 AAAA...",
  "githubAppInstallationId": "12345678"
}

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

PUT

connections

{connectionId}

dbt

Update dbt configuration

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "autogenRelationships": true,
  "branch": "main",
  "enableVirtualSchemas": false,
  "sshUrl": "git@github.com:org/repo.git",
  "authMethod": "ssh",
  "committerEmail": "bot@example.com",
  "committerName": "Omni Bot",
  "dbtVersion": "1.11",
  "enableSemanticLayer": false,
  "githubAppInstallationId": "12345678",
  "projectRootPath": "dbt_project",
  "rotateKeys": false,
  "token": "<string>"
}
'

import requests

url = "https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt"

payload = {
    "autogenRelationships": True,
    "branch": "main",
    "enableVirtualSchemas": False,
    "sshUrl": "git@github.com:org/repo.git",
    "authMethod": "ssh",
    "committerEmail": "bot@example.com",
    "committerName": "Omni Bot",
    "dbtVersion": "1.11",
    "enableSemanticLayer": False,
    "githubAppInstallationId": "12345678",
    "projectRootPath": "dbt_project",
    "rotateKeys": False,
    "token": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    autogenRelationships: true,
    branch: 'main',
    enableVirtualSchemas: false,
    sshUrl: 'git@github.com:org/repo.git',
    authMethod: 'ssh',
    committerEmail: 'bot@example.com',
    committerName: 'Omni Bot',
    dbtVersion: '1.11',
    enableSemanticLayer: false,
    githubAppInstallationId: '12345678',
    projectRootPath: 'dbt_project',
    rotateKeys: false,
    token: '<string>'
  })
};

fetch('https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'autogenRelationships' => true,
    'branch' => 'main',
    'enableVirtualSchemas' => false,
    'sshUrl' => 'git@github.com:org/repo.git',
    'authMethod' => 'ssh',
    'committerEmail' => 'bot@example.com',
    'committerName' => 'Omni Bot',
    'dbtVersion' => '1.11',
    'enableSemanticLayer' => false,
    'githubAppInstallationId' => '12345678',
    'projectRootPath' => 'dbt_project',
    'rotateKeys' => false,
    'token' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt"

	payload := strings.NewReader("{\n  \"autogenRelationships\": true,\n  \"branch\": \"main\",\n  \"enableVirtualSchemas\": false,\n  \"sshUrl\": \"git@github.com:org/repo.git\",\n  \"authMethod\": \"ssh\",\n  \"committerEmail\": \"bot@example.com\",\n  \"committerName\": \"Omni Bot\",\n  \"dbtVersion\": \"1.11\",\n  \"enableSemanticLayer\": false,\n  \"githubAppInstallationId\": \"12345678\",\n  \"projectRootPath\": \"dbt_project\",\n  \"rotateKeys\": false,\n  \"token\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"autogenRelationships\": true,\n  \"branch\": \"main\",\n  \"enableVirtualSchemas\": false,\n  \"sshUrl\": \"git@github.com:org/repo.git\",\n  \"authMethod\": \"ssh\",\n  \"committerEmail\": \"bot@example.com\",\n  \"committerName\": \"Omni Bot\",\n  \"dbtVersion\": \"1.11\",\n  \"enableSemanticLayer\": false,\n  \"githubAppInstallationId\": \"12345678\",\n  \"projectRootPath\": \"dbt_project\",\n  \"rotateKeys\": false,\n  \"token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"autogenRelationships\": true,\n  \"branch\": \"main\",\n  \"enableVirtualSchemas\": false,\n  \"sshUrl\": \"git@github.com:org/repo.git\",\n  \"authMethod\": \"ssh\",\n  \"committerEmail\": \"bot@example.com\",\n  \"committerName\": \"Omni Bot\",\n  \"dbtVersion\": \"1.11\",\n  \"enableSemanticLayer\": false,\n  \"githubAppInstallationId\": \"12345678\",\n  \"projectRootPath\": \"dbt_project\",\n  \"rotateKeys\": false,\n  \"token\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "autogenRelationships": true,
  "branch": "main",
  "dbtVersion": "Auto",
  "enableSemanticLayer": false,
  "enableVirtualSchemas": false,
  "projectRootPath": "dbt_project",
  "sshUrl": "git@github.com:org/repo.git",
  "supportsDbt": true,
  "authMethod": "ssh",
  "committerEmail": "bot@example.com",
  "committerName": "Omni Bot",
  "commitSigningPublicKey": "ssh-ed25519 AAAA...",
  "githubAppInstallationId": "12345678"
}

{
  "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

ID of the connection where dbt is configured

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

autogenRelationships

boolean

required

Automatically generate relationships from dbt

Example:

true

branch

string

required

Git branch name

Minimum string length: 1

Example:

"main"

enableVirtualSchemas

boolean

required

Enable virtual schemas from dbt

Example:

false

sshUrl

string

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/...

Minimum string length: 1

Example:

"git@github.com:org/repo.git"

authMethod

enum<string>

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).

Available options:

ssh,

https_token,

github_app

Example:

"ssh"

committerEmail

string

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.

Example:

"bot@example.com"

committerName

string

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.

Example:

"Omni Bot"

dbtVersion

enum<string> | null

dbt version to use

Available options:

Auto,

1.10,

1.11

Example:

"1.11"

enableSemanticLayer

boolean

default:false

Enable dbt semantic layer integration

Example:

false

githubAppInstallationId

string

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.

Pattern: ^[0-9]+$

Example:

"12345678"

projectRootPath

Path to dbt project root within repository

Pattern: ^(?!\/)(?!.*\.\.)[\w ./-]+$

Example:

"dbt_project"

rotateKeys

boolean

default:false

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

Example:

false

token

string

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

Maximum string length: 1000

Pattern: ^[a-zA-Z0-9_\-.]+$

Response

dbt configuration updated successfully

autogenRelationships

boolean

required

Whether relationships are auto-generated from dbt

Example:

true

branch

string

required

Git branch name

Example:

"main"

dbtVersion

string

required

dbt version being used

Example:

"Auto"

enableSemanticLayer

boolean

required

Whether the dbt semantic layer integration is enabled

Example:

false

enableVirtualSchemas

boolean

required

Whether virtual schemas are enabled

Example:

false

projectRootPath

string | null

required

Path to dbt project root

Example:

"dbt_project"

sshUrl

string

required

Git repository URL

Example:

"git@github.com:org/repo.git"

supportsDbt

boolean

required

Whether the connection dialect supports dbt

Example:

true

authMethod

enum<string>

The authentication method used for git operations:

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

Available options:

ssh,

https_token,

github_app

Example:

"ssh"

committerEmail

Email address used for commit signing. Only returned when a commit signer is configured for GitHub App auth.

Example:

"bot@example.com"

committerName

Name used for commit signing. Only returned when a commit signer is configured for GitHub App auth.

Example:

"Omni Bot"

commitSigningPublicKey

SSH public key used to sign commits. Only returned when a commit signer is configured for GitHub App auth.

Example:

"ssh-ed25519 AAAA..."

githubAppInstallationId

GitHub App installation ID. Only returned when authMethod is github_app.

Example:

"12345678"

⌘I

Getting started

AI APIs

API token APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Update dbt configuration

Authorizations

Path Parameters

Body

Response