Skip to main content

abortDeployment

Cancel a queued or running deployment.

Transitions a PENDING, APPROVED, or RUNNING deployment to ABORTED. The instance's infrastructure state is not changed — a running deployment aborted mid-flight leaves any partial changes the provisioner had applied in place. The deployment queue advances so the next waiting deployment can run.

Aborting a deployment in any other status (COMPLETED, FAILED, REJECTED, ABORTED, or PROPOSED) returns a validation error. To discard a PROPOSED deployment, use rejectDeployment.

abortDeployment(
organizationId: ID!
id: UUID!
): DeploymentPayload

Arguments

abortDeployment.organizationId ● ID! non-null scalar {#organization-id}

Your organization's unique identifier.

abortDeployment.id ● UUID! non-null scalar {#id}

The deployment's unique identifier.

Type

DeploymentPayload object