Stacks

BeginUpdate

BeginUpdate combines CreateUpdate, StartUpdate, ExportStackDeployment, and GetStack into a single endpoint for improved performance. It reduces HTTP round trips during startup by returning all data needed to begin the engine execution.

post/api/stacks/{orgName}/{projectName}/{stackName}/begin-update

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

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

stackNamestring required

The stack name

Request body

journalVersioninteger

JournalVersion indicates the maximum journal version the client supports.

tagsobject

Tags contains the set of tags to associate with the stack.

updateKind'update' | 'preview' | 'refresh' | 'rename' | 'destroy' | 'import' | 'resource-import' | 'Pupdate' | 'Prefresh' | 'Pdestroy' | 'Pimport' | 'Prename' required

UpdateKind specifies the type of update (update, preview, refresh, destroy, resource-import).

Response

OK

journalVersioninteger

JournalVersion indicates the maximum version of journal entries to send.

tokenstring

Token is the lease token to authorize operations on this update.

tokenExpirationinteger

TokenExpiration is a UNIX timestamp by which the token will expire.

updateIDstring required

UpdateID is the opaque identifier of the created update.

versioninteger required

Version is the version of the stack once the update is complete.

Changes

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