Cancel a deployment
PATCH /api/v1/projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}
Requests terminal cancellation with an expected-state CAS. Existing materialized resources are retained for cleanup.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Cancel a deployment. |
environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Cancel a deployment. |
deploymentId | string | required | Identifies the Project Deployment being addressed. Applies to Cancel a deployment. |
Request body
Required — Request body for: Cancel a deployment.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
status | "canceled" | required | |
expectedStatus | "queued" | "validating" | "provisioning" | "materializing" | "ready" | "failed" | "canceled" | optional | |
reason | string | required |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — type: "deployment" (required); id: string (required); projectId: string (required); environmentId: string (required); releaseId: string | null (required); configurationRevisionId: string (required); status: "queued" | "validating" | "provisioning" | "materializing" | "ready" | "failed" | "canceled" (required); diagnostics: object | null (required); createdAt: string (required); updatedAt: string (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |