Deployments

GetDeployment

Retrieves detailed information about a specific Pulumi Deployments execution by its version number within the stack. This is an alternative to fetching by deployment ID and returns the same response structure: deployment status, creation and modification timestamps, the user who requested the deployment, the Pulumi operation type, job details with step-level progress, and any associated stack update results.

get/api/stacks/{orgName}/{projectName}/{stackName}/deployments/version/{version}

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

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

stackNamestring required

The stack name

versionstring required

The deployment version number

Response

OK

createdstring required

Created defines when the Deployment was created.

idstring required

Unique identifier for this deployment.

initiatorstring

Initiator is the initiation source of the deployment.

latestVersioninteger required

LatestVersion is the most recent version number for deployments for the given programID

modifiedstring required

Created defines when the corresponding WorkflowRun was modified.

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

PulumiOperation is the operation that was performed. Omitted for historical deployments that predate this field.

status'not-started' | 'accepted' | 'running' | 'failed' | 'succeeded' | 'skipped' required

The current execution status of the deployment. not-started means the deployment is waiting in the queue. The Pulumi Cloud console shows it as Queued, or as Paused when deployments are paused for the stack or the organization. accepted means the deployment has been taken off the queue for execution but has not started running yet. The console shows it alongside running. Webhook payloads report both not-started and accepted as queued. running means at least one step has started and no step has failed. failed covers, for example, a failed step, a timeout, or a cancellation, whether the deployment was queued or running. skipped means the deployment was removed from the queue without running, either because operationContext.options.skipIntermediateDeployments is enabled for it and a newer deployment of the same operation is queued right behind it for the same stack, or because it was still queued seven days after it was created. Once the deployment's job has started, this matches the job's status.

versioninteger required

Version is the ordinal ID for the stack

Changes

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