Stacks

CreateUpdateForPreview

Creates a new preview update for the given stack. A preview shows what changes would be made without actually applying them, similar to a dry run. This only creates the update record; the update must subsequently be started via the StartUpdateForPreview endpoint. Enforces stack update concurrency checks.

post/api/stacks/{orgName}/{projectName}/{stackName}/preview

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

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

stackNamestring required

The stack name

Request body

configobject required

Configuration values.

descriptionstring required

The description

mainstring required

The main entry point

namestring required

Properties from the Project file. Subset of pack.Package.

runtimestring required

The runtime

Response

OK

updateIDstring required

UpdateID is the opaque identifier of the requested update. This value is needed to begin an update, as well as poll for its progress.

Changes

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