Deployments

EncryptDeploymentSettingsSecret

Encrypts a plaintext secret value for secure storage in Pulumi Deployments settings. Use this endpoint to encrypt sensitive values such as cloud provider credentials, API keys, or other secrets before including them in deployment settings (e.g. as environment variables in operationContext). The encrypted value can then be safely stored in the deployment settings and will be decrypted at deployment execution time. The request body must contain a non-empty plaintext value to encrypt.

post/api/stacks/{orgName}/{projectName}/{stackName}/deployments/settings/encrypt

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/stacks/{orgName}/{projectName}/{stackName}/deployments/settings/encrypt
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

stackNamestring required

The stack name

Request body

ciphertextstring[]

The encrypted representation of the secret value.

plaintextstring

Not a sensitive value, just plaintext.

secretstring required

The secret value in plaintext.

Response

OK

ciphertextstring[]

The encrypted representation of the secret value.

plaintextstring

Not a sensitive value, just plaintext.

secretstring required

The secret value in plaintext.

Changes

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