Runtime Validation

Cancel runtime validation

Move a PENDING or PROCESSING runtime validation run to CANCELLED and set cancelledAt. Terminal runs cannot be cancelled again.

post/api/v2/runtimeValidation/cancelValidation

Request

  • Base URL
    https://zeropath.com
  • Auth
    API key in header X-ZeroPath-API-Token-Id and API key in header X-ZeroPath-API-Token-Secret

Request body

organizationIdstring
runIdstring required

Response

Cancelled validation run

idstring required
profileIdstring required
codeScanIdstring required
status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required

Queue and lifecycle status for a runtime validation run.

triggerReason'USER_REQUESTED' | 'AUTO_AFTER_SCAN' required

Why the validation run was created.

triggeredByUserIdstring nullable required
startedAtstring date-time nullable required
completedAtstring date-time nullable required
cancelledAtstring date-time nullable required
summarystring nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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