curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt/environments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production dbt",
  "targetSchema": "analytics"
}
'

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Production dbt",
  "isDefaultEnvironment": false,
  "isDeferralEnabled": false,
  "ownerId": "550e8400-e29b-41d4-a716-446655440000",
  "targetDatabase": "analytics_db",
  "targetName": null,
  "targetRole": null,
  "targetSchema": "analytics",
  "variables": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "DBT_TARGET",
      "value": "production",
      "isSecret": false
    },
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "name": "DBT_API_KEY",
      "value": null,
      "isSecret": true
    }
  ]
}

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

dbt environments

Create dbt environment

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

dbt environments can be personal (owned by a single user) or shared (owned by no one). To create:

A personal environment for yourself, you’ll need Restricted Querier permissions or higher on the associated Omni model
A personal environment for another user, you’ll need Organization Admin permissions
A shared environment, you’ll need Connection Admin or Organization Admin permissions

POST

connections

{connectionId}

dbt

environments

curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt/environments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production dbt",
  "targetSchema": "analytics"
}
'

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Production dbt",
  "isDefaultEnvironment": false,
  "isDeferralEnabled": false,
  "ownerId": "550e8400-e29b-41d4-a716-446655440000",
  "targetDatabase": "analytics_db",
  "targetName": null,
  "targetRole": null,
  "targetSchema": "analytics",
  "variables": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "DBT_TARGET",
      "value": "production",
      "isSecret": false
    },
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "name": "DBT_API_KEY",
      "value": null,
      "isSecret": true
    }
  ]
}

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

The unique identifier of the connection

Body

application/json

name

string

required

The name of the dbt environment

Minimum string length: 1

Example:

"Production dbt"

targetSchema

string

required

The target schema for the environment

Minimum string length: 1

Example:

"analytics"

isDeferralEnabled

boolean

default:false

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

Example:

false

ownerId

string<uuid> | null

Defines the owner of the environment, which also determines the type of environment (personal or shared) that is created.

Personal environment - Use the ID of the user that owns the environment. Organization Admin permissions are required to set the ID of a user other than the authenticating user.
Shared environment - Set to null. Requires Connection Admin or Organization Admin permissions.

Example:

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

targetDatabase

string | null

Target database override

Example:

"analytics_db"

targetName

string | null

Target name override

Example:

"my_project"

targetRole

string | null

Target role override

Example:

"transformer"

variables

object[]

Environment variables for the dbt environment. Note: While variables is not required, at least one variable object must be defined if variables is included in the request body.

Show child attributes

Response

dbt environment created successfully

string<uuid>

Unique identifier of the dbt environment

name

string

The name of the dbt environment

isDefaultEnvironment

boolean

Whether this is the default environment

isDeferralEnabled

boolean

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

ownerId

string<uuid> | null

The user ID of the owner of the dbt environment, or null

targetDatabase

string | null

Target database override

targetName

string | null

Target name override

targetRole

string | null

Target role override

targetSchema

string

Target schema for the environment

variables

object[]

Environment variables

Show child attributes

Getting started

Who am I?

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

Create dbt environment

Authorizations

Path Parameters

Body

Response