Environments

GetEnvironmentSettings

Returns the current settings for a Pulumi ESC environment, including whether deletion protection is enabled. Deletion protection prevents the environment from being deleted until the setting is explicitly disabled. Settings can be modified via the PatchEnvironmentSettings endpoint.

get/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

Response

OK

deletionProtectedboolean required

Whether the environment is protected from deletion.

Changes

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