Update an environment object

Update an existing Deployment level or Workspace level environment object.

Path parameters

organizationIdstringRequired

The ID of the Organization to which the environment object belongs.

environmentObjectIdstringRequired

The environment object’s ID.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
airflowVariableobjectOptional
autoLinkDeploymentsbooleanOptional

Whether or not to automatically link Deployments to the environment object. Only applicable for WORKSPACE scope

connectionobjectOptional
metricsExportobjectOptional

Response

OK

objectKeystring

The key for the environment object

objectTypeenum

The type of environment object

Allowed values:
scopeenum

The scope of the environment object

Allowed values:
scopeEntityIdstring

The ID of the scope entity where the environment object is created

airflowVariableobjectOptional
autoLinkDeploymentsbooleanOptional

Whether or not to automatically link Deployments to the environment object

connectionobjectOptional
createdAtstringOptional

The time when the environment object was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ

createdByobjectOptional
idstringOptional

The ID of the environment object

metricsExportobjectOptional
sourceScopeenumOptional

The source scope of the environment object, if it is resolved from a link

Allowed values:
sourceScopeEntityIdstringOptional

The source scope entity ID of the environment object, if it is resolved from a link

updatedAtstringOptional

The time when the environment object was updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ

updatedByobjectOptional

Errors