Cancel a release before deployment starts
POST
/v1/release-control/{releaseId}/cancelHow to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| releaseId | path | string | Yes | Release ID |
Query parameters
None.
Body schema
Content type: application/json · Optional
| Field | Type | Required | Description |
|---|---|---|---|
| reason | string | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Cancelled releaseapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| release | object | Yes | — |
| release.id | string | Yes | Unique identifier. |
| release.object | release | Yes | — |
| release.projectId | string | Yes | Project ID. |
| release.target | object | Yes | — |
| release.target.kind | function | metronome | Yes | — |
| release.target.resourceId | string | Yes | — |
| release.candidate | object | Yes | — |
| release.candidate.id | string | Yes | Unique identifier. |
| release.candidate.versionId | string | Yes | — |
| release.candidate.fingerprint | string | Yes | — |
| release.candidate.acceptanceFingerprint | string | Yes | — |
| release.assurance | object | Yes | — |
| release.assurance.runId | string | Yes | — |
| release.assurance.evidenceFingerprint | string | Yes | — |
| release.assurance.decisionFingerprint | string | Yes | — |
| release.action | publish | publish_and_deploy | Yes | — |
| release.status | queued | promoting | ready_for_deployment | deploying | released | failed | cancelled | Yes | Current lifecycle status. |
| release.idempotencyKey | string | Yes | — |
| release.requestFingerprint | string | Yes | — |
| release.evidenceFingerprint | string | Yes | — |
| release.revision | integer | Yes | — |
| release.deployment | object | Yes | — |
| release.deployment.attemptId | string | Yes | — |
| release.deployment.id | string | Yes | Unique identifier. |
| release.deployment.revision | string | Yes | — |
| release.deployment.startedAt | string | Yes | ISO 8601 timestamp. |
| release.deploymentRequest | object | Yes | — |
| release.deploymentRequest.method | POST | Yes | — |
| release.deploymentRequest.path | string | Yes | Workspace-relative file path. |
| release.deploymentRequest.body | object | Yes | — |
| release.deploymentRequest.body.versionId | string | Yes | — |
| release.deploymentRequest.body.releaseId | string | Yes | — |
| release.error | object | Yes | — |
| release.error.code | string | Yes | — |
| release.error.message | string | Yes | Message text. |
| release.promotedAt | string | Yes | — |
| release.completedAt | string | Yes | ISO 8601 timestamp. |
| release.createdAt | string | Yes | ISO 8601 timestamp. |
| release.updatedAt | string | Yes | ISO 8601 timestamp. |
| release.events | object[] | No | — |
| release.events[].sequence | integer | Yes | — |
| release.events[].id | string | Yes | Unique identifier. |
| release.events[].type | string | Yes | — |
| release.events[].actorUserId | string | Yes | — |
| release.events[].payload | object | Yes | — |
| release.events[].createdAt | string | Yes | ISO 8601 timestamp. |
409Release is already terminal or deployment has started
None.
Cancel a release before deployment starts
Loading...
Response 200
Loading...