Deployments

CancelDeployment

Terminates an in-progress Pulumi Deployments execution for a specific stack. If the deployment is currently running, it is stopped immediately. If the deployment is queued but has not yet started, it is removed from the queue.

Warning: Canceling a deployment is a dangerous action and may leave the stack in an inconsistent state if the deployment is canceled during the execution of a Pulumi operation.

Note that this serves two endpoints:

  • /{orgName}/{projectName}/{stackName}/deployments/{deploymentId}/cancel
  • /admin/deployments/{deploymentId}/cancel

The former requires that the requesting user has stack deployment create permissions. The latter requires that the requesting user is a site administrator.

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

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

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

stackNamestring required

The stack name

deploymentIdstring required

The deployment identifier

Response

OK

Changes

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