OMomni
dbt

Get dbt configuration

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

Retrieve the dbt configuration for the specified connection.

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

Response

dbt configuration successfully retrieved

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

SSH URL for git repository

supportsDbtboolean required

Whether the connection dialect supports dbt.

messagestring

Message explaining dbt status. Returned if dbt is not configured.

Example response

{
  "authMethod": "ssh",
  "autogenRelationships": true,
  "branch": "main",
  "dbtVersion": "Auto",
  "projectRootPath": "dbt_project",
  "sshUrl": "git@github.com:org/repo.git",
  "supportsDbt": true,
  "message": "dbt not configured for this connection"
}

Changes

  • 43290040f88fRevision changes
    • 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