Cancel a non-terminal Assurance Run
POST
/v1/assurance/runs/{runId}/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 |
|---|---|---|---|---|
| runId | path | string | Yes | Assurance Run ID |
Query parameters
None.
Body schema
This endpoint does not require a request body.
None.
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Cancelled Assurance Runapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| assuranceRun | object | Yes | — |
| assuranceRun.policyDefinition | object | No | At least one test, evaluation, or optimization gate is required. Gate IDs are unique across all gate kinds. |
| assuranceRun.policyDefinition.schemaVersion | computer_agents_assurance_policy_v3 | No | — |
| assuranceRun.policyDefinition.testGates | object[] | No | — |
| assuranceRun.policyDefinition.testGates[].id | string | No | Unique identifier. |
| assuranceRun.policyDefinition.testGates[].testPlanId | string | Yes | — |
| assuranceRun.policyDefinition.testGates[].versionId | string | No | — |
| assuranceRun.policyDefinition.testGates[].requireCommitSha | boolean | No | — |
| assuranceRun.policyDefinition.testGates[].requireTrustedEvidence | boolean | No | Require control-plane verified execution-worker provenance. Disable only for an explicitly approved legacy/non-release migration policy. |
| assuranceRun.policyDefinition.testGates[].maxAgeHours | number | No | — |
| assuranceRun.policyDefinition.evaluationGates | object[] | No | — |
| assuranceRun.policyDefinition.evaluationGates[].id | string | No | Unique identifier. |
| assuranceRun.policyDefinition.evaluationGates[].evaluationId | string | Yes | — |
| assuranceRun.policyDefinition.evaluationGates[].versionId | string | No | — |
| assuranceRun.policyDefinition.evaluationGates[].minimumAverageScore | number | No | — |
| assuranceRun.policyDefinition.evaluationGates[].minimumPassRate | number | No | — |
| assuranceRun.policyDefinition.evaluationGates[].requiredPurpose | diagnostic | development | optimization | release | external_validation | No | — |
| assuranceRun.policyDefinition.evaluationGates[].requireRunFingerprint | boolean | No | — |
| assuranceRun.policyDefinition.evaluationGates[].requireTrustedEvidence | boolean | No | Require control-plane verified execution-worker provenance for the exact Evaluation result set and immutable bindings. |
| assuranceRun.policyDefinition.evaluationGates[].requireSignedEvidence | boolean | No | Require the canonical Evaluation evidence fingerprint to carry a cryptographically verified Google Cloud KMS signature. |
| assuranceRun.policyDefinition.evaluationGates[].maxAgeHours | number | No | — |
| assuranceRun.policyDefinition.optimizationGates | object[] | No | — |
| assuranceRun.policyDefinition.optimizationGates[].id | string | No | Unique identifier. |
| assuranceRun.policyDefinition.optimizationGates[].agentId | string | Yes | Agent ID. |
| assuranceRun.policyDefinition.optimizationGates[].requireTargetMet | boolean | No | — |
| assuranceRun.policyDefinition.optimizationGates[].requirePublishedCandidate | boolean | No | — |
| assuranceRun.policyDefinition.optimizationGates[].maxAgeHours | number | No | — |
| assuranceRun.policyDefinition.approval | object | No | — |
| assuranceRun.policyDefinition.approval.mode | none | manual | No | — |
| assuranceRun.policyDefinition.budget | object | No | — |
| assuranceRun.policyDefinition.budget.maximumTotalCostUsd | number | No | — |
| assuranceRun.policyVersionNumber | integer | No | — |
| assuranceRun.id | string | Yes | Unique identifier. |
| assuranceRun.assurancePolicyId | string | Yes | — |
| assuranceRun.policyVersionId | string | Yes | — |
| assuranceRun.projectId | string | Yes | Project ID. |
| assuranceRun.releaseId | string | Yes | — |
| assuranceRun.commitSha | string | Yes | — |
| assuranceRun.agentId | string | Yes | Agent ID. |
| assuranceRun.agentVersionId | string | Yes | — |
| assuranceRun.status | running | passed | failed | blocked | cancelled | Yes | Current lifecycle status. |
| assuranceRun.evidenceReferences | object | Yes | — |
| assuranceRun.evidenceReferences.testRunIds | string[] | No | — |
| assuranceRun.evidenceReferences.evaluationRunIds | string[] | No | — |
| assuranceRun.evidenceReferences.optimizationJobIds | string[] | No | — |
| assuranceRun.evidence | object | Yes | — |
| assuranceRun.evidence.schemaVersion | computer_agents_assurance_evidence_v1 | Yes | — |
| assuranceRun.evidence.runId | string | Yes | — |
| assuranceRun.evidence.policyId | string | Yes | — |
| assuranceRun.evidence.policyVersionId | string | Yes | — |
| assuranceRun.evidence.policyFingerprint | string | Yes | — |
| assuranceRun.evidence.subject | object | Yes | — |
| assuranceRun.evidence.subject.projectId | string | Yes | Project ID. |
| assuranceRun.evidence.subject.releaseId | string | Yes | — |
| assuranceRun.evidence.subject.commitSha | string | Yes | — |
| assuranceRun.evidence.subject.agentId | string | Yes | Agent ID. |
| assuranceRun.evidence.subject.agentVersionId | string | Yes | — |
| assuranceRun.evidence.evaluatedAt | string | Yes | — |
| assuranceRun.evidence.gates | object[] | Yes | — |
| assuranceRun.evidence.gates[].id | string | Yes | Unique identifier. |
| assuranceRun.evidence.gates[].kind | test | evaluation | optimization | budget | Yes | — |
| assuranceRun.evidence.gates[].status | passed | failed | pending | Yes | Current lifecycle status. |
| assuranceRun.evidence.gates[].reason | string | Yes | — |
| assuranceRun.evidence.gates[].evidenceId | string | Yes | — |
| assuranceRun.evidence.gates[].evidenceFingerprint | string | Yes | — |
| assuranceRun.evidence.gates[].actual | object | Yes | — |
| assuranceRun.evidence.gates[].required | object | Yes | — |
| assuranceRun.evidence.evidenceReferences | object | Yes | — |
| assuranceRun.evidence.evidenceReferences.testRunIds | string[] | No | — |
| assuranceRun.evidence.evidenceReferences.evaluationRunIds | string[] | No | — |
| assuranceRun.evidence.evidenceReferences.optimizationJobIds | string[] | No | — |
| assuranceRun.evidence.cost | object | Yes | — |
| assuranceRun.evidence.cost.totalCostUsd | number | Yes | — |
| assuranceRun.evidence.cost.complete | boolean | Yes | — |
| assuranceRun.evidence.fingerprint | string | Yes | — |
| assuranceRun.decision | object | Yes | — |
| assuranceRun.decision.schemaVersion | computer_agents_assurance_decision_v1 | Yes | — |
| assuranceRun.decision.runId | string | Yes | — |
| assuranceRun.decision.outcome | passed | failed | pending_evidence | awaiting_approval | Yes | — |
| assuranceRun.decision.technicalOutcome | passed | failed | pending | Yes | — |
| assuranceRun.decision.policyFingerprint | string | Yes | — |
| assuranceRun.decision.evidenceFingerprint | string | Yes | — |
| assuranceRun.decision.approval | object | Yes | — |
| assuranceRun.decision.approval.status | not_required | pending | approved | Yes | Current lifecycle status. |
| assuranceRun.decision.approval.actorId | string | Yes | — |
| assuranceRun.decision.approval.actorType | user | policy | Yes | — |
| assuranceRun.decision.approval.approvedAt | string | Yes | — |
| assuranceRun.decision.approval.evidenceFingerprint | string | Yes | — |
| assuranceRun.decision.decidedAt | string | Yes | — |
| assuranceRun.decision.fingerprint | string | Yes | — |
| assuranceRun.approval | object | Yes | — |
| assuranceRun.approval.approvedByUserId | string | Yes | — |
| assuranceRun.approval.approvedAt | string | Yes | — |
| assuranceRun.approval.evidenceFingerprint | string | Yes | — |
| assuranceRun.revision | integer | Yes | — |
| assuranceRun.metadata | object | Yes | Free-form metadata object. |
| assuranceRun.createdAt | string | Yes | ISO 8601 timestamp. |
| assuranceRun.updatedAt | string | Yes | ISO 8601 timestamp. |
| assuranceRun.completedAt | string | Yes | ISO 8601 timestamp. |
| assuranceRun.events | object[] | No | — |
409Assurance Run is already terminal
None.
Cancel a non-terminal Assurance Run
Loading...
Response 200
Loading...