ZEzeropath
Scans

Cancel a running scan

Cancel a scan that is currently running or queued. Has no effect on already-completed or already-errored scans. The scan status will be set to "Errored" with a cancellation note.

post/api/v2/scans/cancel

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

Organization that owns the scan.

scanIdstring required

ID of the scan to cancel.

Response

Scan cancelled

cancelledboolean required

Whether the scan was successfully cancelled.

Changes

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