OMomniapp
Connections

Update dbt environment

Changed on

Update an existing dbt environment for a connection.

put/api/v1/connections/{connectionId}/dbt/environments/{environmentId}

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/connections/{connectionId}/dbt/environments/{environmentId}
  • Auth
    HTTP bearer

Path parameters

connectionIdstring uuid required

Connection ID

Example:550e8400-e29b-41d4-a716-446655440000
environmentIdstring uuid required

Environment ID

Example:247dc6dc-2a58-4688-9521-c5ed3e99c1e8

Request body

isDeferralEnabledboolean

Whether to enable dbt deferral for this environment. Ignored (forced to false) for the default (production) environment.

namestring required

Environment name

ownerIdstring uuid nullable

User ID of the environment owner. Used to mark development environments belonging to a specific user.

targetDatabasestring nullable

Target database override

targetNamestring nullable

Target name override

targetRolestring nullable

Target role override

targetSchemastring required

Target schema for this environment

Example request

{
  "name": "PR_1111_Expose",
  "targetDatabase": "analytics_dev",
  "targetSchema": "PR_1111_Expose"
}

Response

dbt environment updated successfully

idstring uuid required

Unique environment identifier

isDefaultEnvironmentboolean required

Whether this is the default environment

isDeferralEnabledboolean required

Whether dbt deferral is enabled for this environment. Always false for the default (production) environment — the backend rejects enabling it there.

namestring required

Environment name

ownerIdstring nullable required

User ID of the environment owner, or null if not a personal environment

targetDatabasestring nullable required

Target database override

targetNamestring nullable required

Target name override

targetRolestring nullable required

Target role override

targetSchemastring required

Target schema

Changes