For the complete documentation index, see llms.txt. This page is also available as Markdown.

COS scan status

Use snyk cos scan status to view the current status of a scan.

Usage

snyk cos scan status [<OPTIONS>]

Description

The snyk cos scan status command shows the current status of a scan.

Use the --watch option to poll until the scan reaches a terminal state.

For a list of related commands, visit the Snyk COS help, snyk cos --help.

Exit codes

Possible exit codes and their meaning:

0: status retrieved 3: failure, target ID not found or no scan exists for this target

Configure the Snyk CLI

You can use environment variables to configure the Snyk CLI and set variables to connect to the Snyk API. For more information, visit Configure the Snyk CLI.

Debug

Use the -d option to output the debug logs.

Options

--scan-id=<SCAN_ID>

Required. Specify the scan whose status you want to retrieve. The <SCAN_ID> must be a valid scan ID.

Example:

--watch

Poll until the scan reaches a terminal state.

Allowed values: queued, completed, failed, canceled

Example:

--json

Print results on the console as a JSON data structure.

Example:

Last updated

Was this helpful?