Environments

PatchEnvironmentSettings

Updates settings for a Pulumi ESC environment using a partial update (patch) approach. Currently supports toggling deletion protection via the deletionProtected field. When deletionProtected is set to true, the environment cannot be deleted until the setting is explicitly disabled. Only the fields included in the request body are modified; omitted fields retain their current values.

patch/api/esc/environments/{orgName}/{projectName}/{envName}/settings

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/esc/environments/{orgName}/{projectName}/{envName}/settings
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

envNamestring required

The environment name

Request body

deletionProtectedboolean

DeletionProtected indicates whether deletion protection should be enabled for this environment. Null means no change.

Response

OK

Changes

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