Environments

Update Environment

Partially update an Environment by ID. Omitted fields are unchanged; null clears nullable fields. This operation configures connection metadata only. Add warehouse passwords or OAuth refresh tokens in the Coalesce App under Build Settings > Environments > User Credentials.

patch/api/v1/environments/{environmentID}

Request

  • Base URL: https://app.coalescesoftware.io
  • URL: https://app.coalescesoftware.io/api/v1/environments/{environmentID}
  • Auth: HTTP bearer

Request body

namestring

The Environment name.

descriptionstring

The Environment description.

connectionAccountstring

Snowflake only. The Snowflake account identifier for this environment.

accessUrlstring nullable

Databricks only. The workspace URL for this environment. Pass null to clear.

oauthEnabledboolean

If OAuth is enabled.

defaultStorageMappingstring nullable
runTimeParametersobject

The default Environment parameters. Parameters changed during deploy will not show here.

mappingsEnvironmentStorageLocationMappings

The Storage Mapping name.

Response

Information about an environment.

connectionAccountstring

Snowflake only. The Snowflake account identifier for this environment (for example xy12345.us-east-1). Omit for Databricks projects.

accessUrlstring nullable

Databricks only. The workspace URL for this environment (for example https://adb-1234567890123456.7.azuredatabricks.net). Omit for Snowflake projects.

defaultStorageMappingstring nullable
descriptionstring

The Workspace description.

namestring required

The Workspace name.

oauthEnabledboolean required

If OAuth is enabled.

projectstring required

The Project ID.

createdAtstring date-time required
updatedAtstring date-time required
currentGitBranchstring

The branch most recently run on this environment.

currentGitCommitstring
currentGitURLstring
currentlyRunningJobsinteger[]

An array of any running Jobs. If there are not Jobs running, this will return empty.

idstring required
deployedCommitstring

The most recently deployed commit ID.

status'Deleting' | 'Deploying' | 'Failed Deploy' | 'Failed Refresh' | 'Initializing' | 'Refreshing' | 'Waiting' required
runTimeParametersobject

Parameters changed during deploy will not show here.

currentMappingsEnvironmentStorageLocationMappings

The Storage Mapping name.

Example response

{
  "createdBy": {
    "id": "BGx8EQ1NlLXxMFwFfV5brGgLj813",
    "firstName": "Coalesce",
    "lastName": "Support"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.