UNPKG

snyk

Version:

snyk library and cli utility

50 lines (29 loc) 1.29 kB
--- description: The snyk cos scan cancel command that cancels a running scan. --- # COS scan cancel {% hint style="info" %} **Release status** The `snyk cos` command set is in Closed Beta and is available only for Enterprise plans. If you want to set it up in your Group or Organization, contact your Snyk account team. {% endhint %} ## Usage `snyk cos scan cancel [<OPTIONS>]` ## Description The `snyk cos scan cancel` command cancels a running scan. Findings confirmed before canceling are not preserved. For a list of related commands see the [snyk cos](cos.md) help, `snyk cos --help`. ## Exit codes Possible exit codes and their meaning: **0**: scan stopped\ **2**: failure, no scan is currently running on this target\ **3**: failure, target or scan ID not found ## Configure the Snyk CLI You can use environment variables to configure the Snyk CLI and set variables for connecting with the Snyk API. For more information see [Configure the Snyk CLI](https://docs.snyk.io/snyk-cli/configure-the-snyk-cli). ## Debug Use the `-d` option to output the debug logs. ## Options ### `--scan-id=<SCAN_ID>` **Required**. Specify the scan to cancel. The `<SCAN_ID>` must be a valid scan ID. Example: ```bash $ snyk cos scan cancel --scan-id=92b10f07ec07c7b1b73305181398ccf5 ```