Environments

CheckEnvironment

Checks a Pulumi ESC environment definition for errors without applying changes. This validates the YAML definition including imports, provider configurations, function invocations (fn::open, fn::secret, etc.), and interpolation expressions. When the showSecrets query parameter is set to true, secret values are returned in plaintext in the response. The response includes any diagnostics or validation errors found in the environment definition. Supports optimistic concurrency control via ETag headers.

post/api/preview/environments/{orgName}/{envName}/check

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/preview/environments/{orgName}/{envName}/check
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

envNamestring required

The environment name

Query parameters

showSecretsboolean

Whether to show secret values in plaintext

Response

OK

exprsobject

Exprs contains the AST for each expression in the environment definition.

propertiesobject

Properties contains the detailed values produced by the environment.

Changes

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