Deployments

Create a new deployment

Initiates a new Pulumi Deployments execution for a stack. Pulumi Deployments is a managed service that executes Pulumi operations (update, preview, refresh, or destroy) in a secure, hosted environment.

Important: The stack must already exist before a deployment can be created for it.

The operation field is required and accepts: update, preview, refresh, or destroy. Three usage modes are supported:

  1. Stack settings only: Send {"operation": "update"} to use the stack's saved deployment settings.
  2. Merged settings: Include partial settings in the request body alongside operation. When inheritSettings is true (the default), request settings are merged with saved stack settings, with request values taking precedence.
  3. Request settings only: Set inheritSettings to false and provide all settings in the request body.

Settings include source context (git repo, branch, directory), operation context (environment variables, pre-run commands, OIDC configuration), executor context, GitHub integration settings, and cache options.

This is v2 with breaking changes from CreateAPIDeploymentHandler: inheritSettings defaults to true, and operation is a required top-level field and no longer valid as part of operationContext.

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

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

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

stackNamestring required

The stack name

Request body

agentPoolIDstring

The identifier of the agent pool to use for deployments.

tagstring

A tag to identify the deployment settings configuration.

inheritSettingsboolean

Whether this deployment should inherit the stack's deployment settings. Defaults to true.

operation'update' | 'preview' | 'destroy' | 'refresh' | 'detect-drift' | 'remediate-drift'

The Pulumi operation to perform.

Response

Accepted

consoleUrlstring required

The Pulumi Console URL for the deployment.

idstring required

The generated deployment identifier.

versioninteger required

The numerical sequential version for the deployment.

Changes

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