Skip to main content

Scans

probely scans - CLI interface​

Manage existing scans

probely scans {get,pause,cancel,resume} ...

probely scans get​

List scans. Use filters or identifiers to narrow the list

probely scans get [-h] [--api-key API_KEY] [--debug] [--f-search SEARCH_TERM]
                  [--f-status {CANCELED,CANCELING,COMPLETED,FAILED,PAUSED,PAUSING,QUEUED,RESUMING,STARTED,UNDER_REVIEW,FINISHING_UP} [{CANCELED,CANCELING,COMPLETED,FAILED,PAUSED,PAUSING,QUEUED,RESUMING,STARTED,UNDER_REVIEW,FINISHING_UP} ...]]
                  [--f-target TARGET_ID [TARGET_ID ...]]
                  [--f-target-label TARGET_LABEL_ID [TARGET_LABEL_ID ...]]
                  [--f-completed-gt ISO_8601_DATETIME] [--f-completed-gte ISO_8601_DATETIME]
                  [--f-completed-lt ISO_8601_DATETIME] [--f-completed-lte ISO_8601_DATETIME]
                  [--f-started-gt ISO_8601_DATETIME] [--f-started-gte ISO_8601_DATETIME]
                  [--f-started-lt ISO_8601_DATETIME] [--f-started-lte ISO_8601_DATETIME]
                  [-o {YAML,JSON,TABLE,IDS_ONLY}]
                  [SCAN_ID ...]

probely scans get positional arguments​

  • SCAN_ID - Identifiers of the scans to list

probely scans get options​

  • -h, --help - show this help message and exit
  • --api-key API_KEY - Authorization token to make requests to the API
  • --debug - Enables debug mode setting
  • -o OUTPUT_FORMAT, --output OUTPUT_FORMAT - Changes the output formats based on presets

probely scans get Available Filters​

  • --f-search SEARCH_TERM - Filter scans matching the scan URL, target name, target URL, or labels
  • --f-status F_STATUS - Filter by Scan status
  • --f-target TARGET_ID - Filter scans by target IDs
  • --f-target-label TARGET_LABEL_ID - Filter scans by target label IDs
  • --f-completed-gt ISO_8601_DATETIME - Filter scans completed after timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-completed-gte ISO_8601_DATETIME - Filter scans completed after, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-completed-lt ISO_8601_DATETIME - Filter scans completed before timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-completed-lte ISO_8601_DATETIME - Filter scans completed before, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-gt ISO_8601_DATETIME - Filter scans started after timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-gte ISO_8601_DATETIME - Filter scans started after, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-lt ISO_8601_DATETIME - Filter scans started before timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-lte ISO_8601_DATETIME - Filter scans started before, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30

probely scans pause​

Pause running scans given by identifiers or the results of filters

probely scans pause [-h] [--api-key API_KEY] [--debug] [--f-search SEARCH_TERM]
                    [--f-status {CANCELED,CANCELING,COMPLETED,FAILED,PAUSED,PAUSING,QUEUED,RESUMING,STARTED,UNDER_REVIEW,FINISHING_UP} [{CANCELED,CANCELING,COMPLETED,FAILED,PAUSED,PAUSING,QUEUED,RESUMING,STARTED,UNDER_REVIEW,FINISHING_UP} ...]]
                    [--f-target TARGET_ID [TARGET_ID ...]]
                    [--f-target-label TARGET_LABEL_ID [TARGET_LABEL_ID ...]]
                    [--f-completed-gt ISO_8601_DATETIME]
                    [--f-completed-gte ISO_8601_DATETIME]
                    [--f-completed-lt ISO_8601_DATETIME]
                    [--f-completed-lte ISO_8601_DATETIME] [--f-started-gt ISO_8601_DATETIME]
                    [--f-started-gte ISO_8601_DATETIME] [--f-started-lt ISO_8601_DATETIME]
                    [--f-started-lte ISO_8601_DATETIME] [-o {YAML,JSON,TABLE,IDS_ONLY}]
                    [SCAN_ID ...]

probely scans pause positional arguments​

  • SCAN_ID - Identifiers of the scans to pause.

probely scans pause options​

  • -h, --help - show this help message and exit
  • --api-key API_KEY - Authorization token to make requests to the API
  • --debug - Enables debug mode setting
  • -o OUTPUT_FORMAT, --output OUTPUT_FORMAT - Changes the output formats based on presets

probely scans pause Available Filters​

  • --f-search SEARCH_TERM - Filter scans matching the scan URL, target name, target URL, or labels
  • --f-status F_STATUS - Filter by Scan status
  • --f-target TARGET_ID - Filter scans by target IDs
  • --f-target-label TARGET_LABEL_ID - Filter scans by target label IDs
  • --f-completed-gt ISO_8601_DATETIME - Filter scans completed after timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-completed-gte ISO_8601_DATETIME - Filter scans completed after, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-completed-lt ISO_8601_DATETIME - Filter scans completed before timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-completed-lte ISO_8601_DATETIME - Filter scans completed before, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-gt ISO_8601_DATETIME - Filter scans started after timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-gte ISO_8601_DATETIME - Filter scans started after, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-lt ISO_8601_DATETIME - Filter scans started before timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-lte ISO_8601_DATETIME - Filter scans started before, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30

probely scans cancel​

Stop unfinished scans given by identifiers or the results of filters

probely scans cancel [-h] [--api-key API_KEY] [--debug] [--f-search SEARCH_TERM]
                     [--f-status {CANCELED,CANCELING,COMPLETED,FAILED,PAUSED,PAUSING,QUEUED,RESUMING,STARTED,UNDER_REVIEW,FINISHING_UP} [{CANCELED,CANCELING,COMPLETED,FAILED,PAUSED,PAUSING,QUEUED,RESUMING,STARTED,UNDER_REVIEW,FINISHING_UP} ...]]
                     [--f-target TARGET_ID [TARGET_ID ...]]
                     [--f-target-label TARGET_LABEL_ID [TARGET_LABEL_ID ...]]
                     [--f-completed-gt ISO_8601_DATETIME]
                     [--f-completed-gte ISO_8601_DATETIME]
                     [--f-completed-lt ISO_8601_DATETIME]
                     [--f-completed-lte ISO_8601_DATETIME] [--f-started-gt ISO_8601_DATETIME]
                     [--f-started-gte ISO_8601_DATETIME] [--f-started-lt ISO_8601_DATETIME]
                     [--f-started-lte ISO_8601_DATETIME] [-o {YAML,JSON,TABLE,IDS_ONLY}]
                     [SCAN_ID ...]

probely scans cancel positional arguments​

  • SCAN_ID - Identifiers of the scans to cancel

probely scans cancel options​

  • -h, --help - show this help message and exit
  • --api-key API_KEY - Authorization token to make requests to the API
  • --debug - Enables debug mode setting
  • -o OUTPUT_FORMAT, --output OUTPUT_FORMAT - Changes the output formats based on presets

probely scans cancel Available Filters​

  • --f-search SEARCH_TERM - Filter scans matching the scan URL, target name, target URL, or labels
  • --f-status F_STATUS - Filter by Scan status
  • --f-target TARGET_ID - Filter scans by target IDs
  • --f-target-label TARGET_LABEL_ID - Filter scans by target label IDs
  • --f-completed-gt ISO_8601_DATETIME - Filter scans completed after timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-completed-gte ISO_8601_DATETIME - Filter scans completed after, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-completed-lt ISO_8601_DATETIME - Filter scans completed before timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-completed-lte ISO_8601_DATETIME - Filter scans completed before, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-gt ISO_8601_DATETIME - Filter scans started after timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-gte ISO_8601_DATETIME - Filter scans started after, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-lt ISO_8601_DATETIME - Filter scans started before timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-lte ISO_8601_DATETIME - Filter scans started before, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30

probely scans resume​

Resume paused scans given by identifiers or the results of filters

probely scans resume [-h] [--api-key API_KEY] [--debug] [--f-search SEARCH_TERM]
                     [--f-status {CANCELED,CANCELING,COMPLETED,FAILED,PAUSED,PAUSING,QUEUED,RESUMING,STARTED,UNDER_REVIEW,FINISHING_UP} [{CANCELED,CANCELING,COMPLETED,FAILED,PAUSED,PAUSING,QUEUED,RESUMING,STARTED,UNDER_REVIEW,FINISHING_UP} ...]]
                     [--f-target TARGET_ID [TARGET_ID ...]]
                     [--f-target-label TARGET_LABEL_ID [TARGET_LABEL_ID ...]]
                     [--f-completed-gt ISO_8601_DATETIME]
                     [--f-completed-gte ISO_8601_DATETIME]
                     [--f-completed-lt ISO_8601_DATETIME]
                     [--f-completed-lte ISO_8601_DATETIME] [--f-started-gt ISO_8601_DATETIME]
                     [--f-started-gte ISO_8601_DATETIME] [--f-started-lt ISO_8601_DATETIME]
                     [--f-started-lte ISO_8601_DATETIME] [-o {YAML,JSON,TABLE,IDS_ONLY}]
                     [--ignore-blackout-period]
                     [SCAN_ID ...]

probely scans resume positional arguments​

  • SCAN_ID - Identifiers of the scans to resume

probely scans resume options​

  • -h, --help - show this help message and exit
  • --api-key API_KEY - Authorization token to make requests to the API
  • --debug - Enables debug mode setting
  • -o OUTPUT_FORMAT, --output OUTPUT_FORMAT - Changes the output formats based on presets
  • --ignore-blackout-period - Ignore blackout period settings

probely scans resume Available Filters​

  • --f-search SEARCH_TERM - Filter scans matching the scan URL, target name, target URL, or labels
  • --f-status F_STATUS - Filter by Scan status
  • --f-target TARGET_ID - Filter scans by target IDs
  • --f-target-label TARGET_LABEL_ID - Filter scans by target label IDs
  • --f-completed-gt ISO_8601_DATETIME - Filter scans completed after timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-completed-gte ISO_8601_DATETIME - Filter scans completed after, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-completed-lt ISO_8601_DATETIME - Filter scans completed before timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-completed-lte ISO_8601_DATETIME - Filter scans completed before, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-gt ISO_8601_DATETIME - Filter scans started after timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-gte ISO_8601_DATETIME - Filter scans started after, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-lt ISO_8601_DATETIME - Filter scans started before timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30
  • --f-started-lte ISO_8601_DATETIME - Filter scans started before, or at, timestamp. Eg: 2020-07-05 or 2020-07-05T12:45:30