These docs are for v1.1. Click to read the latest docs for v1.2.

Stopping a Scan

This command stops a scan by its ID: bright-cli scan:stop [options] <scan id>.

Arguments

ArgumentDescription
<scan id>The ID of an existing scan that you want to stop

Options

OptionDescription
--token=apiKey, -t=apiKeyThe unique identifier used to authenticate a user. The token (API key) can be issued in your organization’s dashboard.
--config=pathToConfigSpecifies the path to the configuration file. By default, the CLI tries to discover the config in the package.json in the root directory of your application or a separate file by a specified name in the working directory. For details, see Configuration Files for more information.

--log-level=0/1/2/3/4/silent/ error/warn/notice/verbose

Allows setting the level of logs to report. Any logs of a higher level than the one specified are shown. The options to select: 0, 1, 2, 3, 4, "silent", "error", "warn", "notice", and "verbose".

  • Default: 3
--cluster

Bright cluster (domain name).

  • Default: https://app.brightsec.com
--insecureAllows the Bright CLI to proceed and operate even if the server connection is considered insecure.
--proxy=socksProxyUrl

SOCKS URL to proxy all traffic.

  • Note: SOCKS4, SOCKS5, SOCKS4a, and SOCKS5h are currently supported. By default, if you specify SOCKS://<URL>, then SOCKS5h is applied.
--api=clusterUrl