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

{
  "id": "247dc6dc-2a58-4688-9521-c5ed3e99c1e8",
  "name": "Development",
  "isDefaultEnvironment": false,
  "isDeferralEnabled": true,
  "ownerId": "550e8400-e29b-41d4-a716-446655440000",
  "targetDatabase": "analytics_dev",
  "targetName": "custom_target",
  "targetRole": "developer",
  "targetSchema": "dev_schema",
  "variables": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "DBT_TARGET",
    "value": "staging",
    "isSecret": false
  }
}

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

Update dbt environment

The permissions required depend on who owns the environment:

Your own personal environment - Restricted Querier permissions or higher on the connection
A shared environment - Connection Admin or Organization Admin permissions
Another user’s personal environment - Organization Admin permissions

Update an existing dbt environment on the specified connection. This request replaces the environment: name and targetSchema are required, and any omitted optional field is reset to its default. In particular, omitting ownerId sets it to null, which converts the environment to a shared one and requires Connection Admin permissions - send your own user ID when updating your own environment.

PUT

connections

{connectionId}

dbt

environments

{environmentId}

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

{
  "id": "247dc6dc-2a58-4688-9521-c5ed3e99c1e8",
  "name": "Development",
  "isDefaultEnvironment": false,
  "isDeferralEnabled": true,
  "ownerId": "550e8400-e29b-41d4-a716-446655440000",
  "targetDatabase": "analytics_dev",
  "targetName": "custom_target",
  "targetRole": "developer",
  "targetSchema": "dev_schema",
  "variables": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "DBT_TARGET",
    "value": "staging",
    "isSecret": false
  }
}

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

environmentId

string<uuid>

required

The unique identifier of the dbt environment

Body

application/json

name

string

required

The name of the dbt environment

Minimum string length: 1

Example:

"Development"

targetSchema

string

required

The target schema for the environment

Minimum string length: 1

Example:

"dev_schema"

isDeferralEnabled

boolean

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

Example:

true

ownerId

string<uuid> | null

Defines the owner of the environment, which also determines whether the environment is personal or shared. Defaults to null when omitted, so always send the current owner's ID unless you intend to change it.

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

targetName

string | null

Target name override

Example:

"custom_target"

targetRole

string | null

Target role override

Example:

"developer"

variables

object[]

Environment variables for the dbt environment. To update existing variables, include the variable id field. New variables should omit the id field.

Show child attributes

Response

dbt environment updated 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?

Administration APIs

AI APIs

App APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Embed APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Update dbt environment

Authorizations

Path Parameters

Body

Response