Environments

GetEnvironmentMetadata

Returns metadata for a Pulumi ESC environment, including the calling user's effective permission level (read, open, write, admin), creation and modification timestamps, the environment's project, and other administrative information. This is useful for determining what actions the current user can perform on the environment before attempting those operations.

get/api/preview/environments/{orgName}/{envName}/metadata

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}/metadata
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

envNamestring required

The environment name

Response

OK

gatedActionsstring[]

GatedActions indicates which actions on this environment require change request approval.

idstring required

Environment metadata follows other Pulumi Cloud "Metadata" fields and contains read-only information about the environment

oidcSubjectV2string

The subject Pulumi signs into OIDC tokens minted by an fn::open::oidc provider declared in this environment. A provider this environment imports from elsewhere mints the subject of the environment that declares it.

openRequestNeededboolean

OpenRequestNeeded indicates whether an open request is currently needed in order to open the environment.

Changes

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