v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB

dbt

Create dbt environment

<Note> This endpoint requires **Connection Admin** permissions for the connection. </Note>

Create a new dbt environment on the specified connection, enabling programmatic environment management.

A dbt environment allows you to connect Omni to a specific dbt project and manage dbt-related functionality within the connection context.

post/v1/connections/{connectionId}/dbt/environments

Path parameters

connectionIdstring uuid required

The unique identifier of the connection

Request body

namestring required

The name of the dbt environment

targetSchemastring required

The target schema for the environment

isDeferralEnabledboolean

Whether deferral is enabled for this environment. Defaults to false. Ignored (forced to false) for the default (production) environment.

ownerIdstring uuid nullable

Only valid with Organization API keys. The user ID of the owner for the dbt environment. Personal Access Tokens (PATs) automatically use the authenticated user as the owner.

targetDatabasestring nullable

Target database override

targetNamestring nullable

Target name override

targetRolestring nullable

Target role override

Example request

{
  "name": "Production dbt",
  "targetSchema": "analytics",
  "ownerId": "550e8400-e29b-41d4-a716-446655440000",
  "targetDatabase": "analytics_db",
  "targetName": "my_project",
  "targetRole": "transformer",
  "variables": [
    {
      "name": "DBT_TARGET",
      "value": "production"
    }
  ]
}

Response

dbt environment created successfully

idstring uuid

Unique identifier of the dbt environment

namestring

The name of the dbt environment

isDefaultEnvironmentboolean

Whether this is the default environment

isDeferralEnabledboolean

Whether deferral is enabled for this environment. Ignored (forced to false) for the default (production) environment.