Targets

probely targets - CLI interface

Create, manage and scan targets

probely targets
                {get,add,update,start-scan,follow-scan,schedule-scan,add-sequence,add-extra-host,delete} ...

probely targets get

List your account’s targets. Use filters or identifiers to narrow the list

probely targets get [-h] [--api-key API_KEY] [--debug] [--f-has-unlimited-scans {TRUE,FALSE}]
                    [--f-is-url-verified {TRUE,FALSE}]
                    [--f-risk {NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} [{NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} ...]]
                    [--f-type {WEB,API} [{WEB,API} ...]] [--f-search SEARCH_TERM]
                    [--f-label F_LABEL [F_LABEL ...]] [--f-label-logical-operator {AND,OR}]
                    [--f-scan-profile F_SCAN_PROFILE [F_SCAN_PROFILE ...]]
                    [-o {YAML,JSON,TABLE,IDS_ONLY}]
                    [TARGET_ID ...]

probely targets get positional arguments

• TARGET_ID - Identifiers of the targets to list

probely targets 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 targets get Available Filters

• --f-has-unlimited-scans F_HAS_UNLIMITED_SCANS - Filter if target has unlimited scans
• --f-is-url-verified F_IS_URL_VERIFIED - Filter targets by verified (true) or not verified (false) domain
• --f-risk F_RISK - Filter targets by risk
• --f-type F_TYPE - Filter targets by type
• --f-search SEARCH_TERM - Filter Targets matching name, url or labels
• --f-label F_LABEL - Filter Targets by Targets Label IDs
• --f-label-logical-operator F_LABEL_LOGICAL_OPERATOR - Logical operator to apply when filtering labels
• --f-scan-profile F_SCAN_PROFILE - Filter Targets by Scan Profile identifiers

probely targets add

Add WEB or API targets you intend to scan

probely targets add [-h] [--api-key API_KEY] [--debug] [-f YAML_FILE_PATH]
                    [-o {YAML,JSON,TABLE,IDS_ONLY}] [--target-name TARGET_NAME]
                    [--target-type {WEB,API}] [--api-schema-type {OPENAPI,POSTMAN}]
                    [--api-schema-file-url API_SCHEMA_FILE_URL] [--api-schema-file FILE_PATH]
                    [TARGET_URL]

probely targets add positional arguments

• TARGET_URL - Url of target

probely targets add 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
• -f YAML_FILE_PATH, --yaml-file YAML_FILE_PATH - Path to file with content to apply. Accepts same payload as listed in API docs
• -o OUTPUT_FORMAT, --output OUTPUT_FORMAT - Changes the output formats based on presets
• --target-name TARGET_NAME - Display name of target
• --target-type TARGET_TYPE - Set type of target being add
• --api-schema-type API_SCHEMA_TYPE - Type of schema for API Targets
• --api-schema-file-url API_SCHEMA_FILE_URL - URL to download the target’s API schema
• --api-schema-file FILE_PATH - File System Path of target’s API schema (JSON or YAML)

probely targets update

Edit targets given by identifiers or the results of filters

probely targets update [-h] [--api-key API_KEY] [--debug]
                       [--f-has-unlimited-scans {TRUE,FALSE}]
                       [--f-is-url-verified {TRUE,FALSE}]
                       [--f-risk {NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} [{NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} ...]]
                       [--f-type {WEB,API} [{WEB,API} ...]] [--f-search SEARCH_TERM]
                       [--f-label F_LABEL [F_LABEL ...]]
                       [--f-label-logical-operator {AND,OR}]
                       [--f-scan-profile F_SCAN_PROFILE [F_SCAN_PROFILE ...]]
                       [-f YAML_FILE_PATH] [-o {YAML,JSON,TABLE,IDS_ONLY}]
                       [TARGET_ID ...]

probely targets update positional arguments

• TARGET_ID - Identifiers of the targets to update

probely targets update 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
• -f YAML_FILE_PATH, --yaml-file YAML_FILE_PATH - Path to file with content to apply. Accepts same payload as listed in API docs
• -o OUTPUT_FORMAT, --output OUTPUT_FORMAT - Changes the output formats based on presets

probely targets update Available Filters

• --f-has-unlimited-scans F_HAS_UNLIMITED_SCANS - Filter if target has unlimited scans
• --f-is-url-verified F_IS_URL_VERIFIED - Filter targets by verified (true) or not verified (false) domain
• --f-risk F_RISK - Filter targets by risk
• --f-type F_TYPE - Filter targets by type
• --f-search SEARCH_TERM - Filter Targets matching name, url or labels
• --f-label F_LABEL - Filter Targets by Targets Label IDs
• --f-label-logical-operator F_LABEL_LOGICAL_OPERATOR - Logical operator to apply when filtering labels
• --f-scan-profile F_SCAN_PROFILE - Filter Targets by Scan Profile identifiers

probely targets start-scan

Scan targets given by identifiers or the results of filters

probely targets start-scan [-h] [--api-key API_KEY] [--debug]
                           [--f-has-unlimited-scans {TRUE,FALSE}]
                           [--f-is-url-verified {TRUE,FALSE}]
                           [--f-risk {NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} [{NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} ...]]
                           [--f-type {WEB,API} [{WEB,API} ...]] [--f-search SEARCH_TERM]
                           [--f-label F_LABEL [F_LABEL ...]]
                           [--f-label-logical-operator {AND,OR}]
                           [--f-scan-profile F_SCAN_PROFILE [F_SCAN_PROFILE ...]]
                           [-f YAML_FILE_PATH] [-o {YAML,JSON,TABLE,IDS_ONLY}]
                           [TARGET_ID ...]

probely targets start-scan positional arguments

• TARGET_ID - Identifiers of the targets to scan

probely targets start-scan 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
• -f YAML_FILE_PATH, --yaml-file YAML_FILE_PATH - Path to file with content to apply. Accepts same payload as listed in API docs
• -o OUTPUT_FORMAT, --output OUTPUT_FORMAT - Changes the output formats based on presets

probely targets start-scan Available Filters

• --f-has-unlimited-scans F_HAS_UNLIMITED_SCANS - Filter if target has unlimited scans
• --f-is-url-verified F_IS_URL_VERIFIED - Filter targets by verified (true) or not verified (false) domain
• --f-risk F_RISK - Filter targets by risk
• --f-type F_TYPE - Filter targets by type
• --f-search SEARCH_TERM - Filter Targets matching name, url or labels
• --f-label F_LABEL - Filter Targets by Targets Label IDs
• --f-label-logical-operator F_LABEL_LOGICAL_OPERATOR - Logical operator to apply when filtering labels
• --f-scan-profile F_SCAN_PROFILE - Filter Targets by Scan Profile identifiers

probely targets follow-scan

Initiate a scan and wait for the results

probely targets follow-scan [-h] [--api-key API_KEY] [--debug] [-f YAML_FILE_PATH]
                            [-o {YAML,JSON,TABLE,IDS_ONLY}] [--timeout MINUTES]
                            [--severity-threshold {LOW,MEDIUM,HIGH,CRITICAL}]
                            [--fail-immediately] [--continue-scan]
                            TARGET_ID

probely targets follow-scan positional arguments

• TARGET_ID - Identifier of target to scan and follow results

probely targets follow-scan 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
• -f YAML_FILE_PATH, --yaml-file YAML_FILE_PATH - Path to file with content to apply. Accepts same payload as listed in API docs
• -o OUTPUT_FORMAT, --output OUTPUT_FORMAT - Changes the output formats based on presets
• --timeout MINUTES - Maximum time to wait for the scan. If reached, the command fails and the scan is canceled
• --severity-threshold SEVERITY_THRESHOLD - Minimum vulnerability severity level required to fail the command
• --fail-immediately - Fail the command when the first vulnerability meeting the threshold is found
• --continue-scan - Do not cancel the scan if the command times out or fails

probely targets schedule-scan

Schedule to Scan Targets given by identifiers or the results of filters

probely targets schedule-scan [-h] [--api-key API_KEY] [--debug]
                              [--f-has-unlimited-scans {TRUE,FALSE}]
                              [--f-is-url-verified {TRUE,FALSE}]
                              [--f-risk {NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} [{NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} ...]]
                              [--f-type {WEB,API} [{WEB,API} ...]] [--f-search SEARCH_TERM]
                              [--f-label F_LABEL [F_LABEL ...]]
                              [--f-label-logical-operator {AND,OR}]
                              [--f-scan-profile F_SCAN_PROFILE [F_SCAN_PROFILE ...]]
                              [-f YAML_FILE_PATH] [-o {YAML,JSON,TABLE,IDS_ONLY}]
                              [--date-time ISO_8601_DATETIME] [--timezone TIMEZONE]
                              [--recurrence {NEVER,HOURLY,DAILY,WEEKLY,MONTHLY,QUARTERLY}]
                              [--scan-profile SCAN_PROFILE_ID]
                              [--day-of-week {MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY}]
                              [--week-of-month {FIRST,SECOND,THIRD,FOURTH,LAST}]
                              [TARGET_ID ...]

probely targets schedule-scan positional arguments

• TARGET_ID - Identifiers of the targets to schedule scans

probely targets schedule-scan 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
• -f YAML_FILE_PATH, --yaml-file YAML_FILE_PATH - Path to file with content to apply. Accepts same payload as listed in API docs
• -o OUTPUT_FORMAT, --output OUTPUT_FORMAT - Changes the output formats based on presets
• --date-time ISO_8601_DATETIME - Timestamp to start Scanning. Eg: 2020-07-05 or 2020-07-05T12:45:30. Default to 'UTC'
• --timezone TIMEZONE - '--date-time' Timezone
• --recurrence RECURRENCE - Defines periodicity for scanning
• --scan-profile SCAN_PROFILE_ID - Scan Profile to be used in this scheduled scan
• --day-of-week DAY_OF_WEEK - Set specific day of week for scanning
• --week-of-month WEEK_OF_MONTH - Set specific week of month for scanning

probely targets schedule-scan Available Filters

• --f-has-unlimited-scans F_HAS_UNLIMITED_SCANS - Filter if target has unlimited scans
• --f-is-url-verified F_IS_URL_VERIFIED - Filter targets by verified (true) or not verified (false) domain
• --f-risk F_RISK - Filter targets by risk
• --f-type F_TYPE - Filter targets by type
• --f-search SEARCH_TERM - Filter Targets matching name, url or labels
• --f-label F_LABEL - Filter Targets by Targets Label IDs
• --f-label-logical-operator F_LABEL_LOGICAL_OPERATOR - Logical operator to apply when filtering labels
• --f-scan-profile F_SCAN_PROFILE - Filter Targets by Scan Profile identifiers

probely targets add-sequence

Add navigation or login Sequences

probely targets add-sequence [-h] [--api-key API_KEY] [--debug]
                             [--f-has-unlimited-scans {TRUE,FALSE}]
                             [--f-is-url-verified {TRUE,FALSE}]
                             [--f-risk {NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} [{NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} ...]]
                             [--f-type {WEB,API} [{WEB,API} ...]] [--f-search SEARCH_TERM]
                             [--f-label F_LABEL [F_LABEL ...]]
                             [--f-label-logical-operator {AND,OR}]
                             [--f-scan-profile F_SCAN_PROFILE [F_SCAN_PROFILE ...]]
                             [-f YAML_FILE_PATH] [-o {YAML,JSON,TABLE,IDS_ONLY}]
                             [--name NAME] [--type {LOGIN,NAVIGATION}]
                             [--enabled {TRUE,FALSE}]
                             [--requires-authentication {TRUE,FALSE}]
                             [--sequence-steps-file FILE_PATH]
                             [TARGET_ID ...]

probely targets add-sequence positional arguments

• TARGET_ID - Identifiers of the targets to add the Sequence

probely targets add-sequence 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

• -f YAML_FILE_PATH, --yaml-file YAML_FILE_PATH - Path to file with content to apply. Accepts same payload as listed in API docs

• -o OUTPUT_FORMAT, --output OUTPUT_FORMAT - Changes the output formats based on presets

• --name NAME - Display name of the sequence

• --type TYPE - Set type of sequence being added

• --enabled ENABLED - Set if sequence is enabled

• --requires-authentication REQUIRES_AUTHENTICATION - Set sequence requires scan to be authenticated

• --sequence-steps-file FILE_PATH - Sequence``’s content file with list of step objects. Supports ‘JSON’ file from ‘Probely Sequence Recorder’ Chrome’

  ``

  s Extension

probely targets add-sequence Available Filters

• --f-has-unlimited-scans F_HAS_UNLIMITED_SCANS - Filter if target has unlimited scans
• --f-is-url-verified F_IS_URL_VERIFIED - Filter targets by verified (true) or not verified (false) domain
• --f-risk F_RISK - Filter targets by risk
• --f-type F_TYPE - Filter targets by type
• --f-search SEARCH_TERM - Filter Targets matching name, url or labels
• --f-label F_LABEL - Filter Targets by Targets Label IDs
• --f-label-logical-operator F_LABEL_LOGICAL_OPERATOR - Logical operator to apply when filtering labels
• --f-scan-profile F_SCAN_PROFILE - Filter Targets by Scan Profile identifiers

probely targets add-extra-host

Add Extra Host to your Targets

probely targets add-extra-host [-h] [--api-key API_KEY] [--debug]
                               [--f-has-unlimited-scans {TRUE,FALSE}]
                               [--f-is-url-verified {TRUE,FALSE}]
                               [--f-risk {NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} [{NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} ...]]
                               [--f-type {WEB,API} [{WEB,API} ...]] [--f-search SEARCH_TERM]
                               [--f-label F_LABEL [F_LABEL ...]]
                               [--f-label-logical-operator {AND,OR}]
                               [--f-scan-profile F_SCAN_PROFILE [F_SCAN_PROFILE ...]]
                               [-f YAML_FILE_PATH] [-o {YAML,JSON,TABLE,IDS_ONLY}]
                               [--host HOST] [--skip-reachability-check]
                               [--include {TRUE,FALSE}] [--name NAME]
                               [--description DESCRIPTION]
                               [TARGET_ID ...]

probely targets add-extra-host positional arguments

• TARGET_ID - Identifiers of the targets to add Extra Host

probely targets add-extra-host 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
• -f YAML_FILE_PATH, --yaml-file YAML_FILE_PATH - Path to file with content to apply. Accepts same payload as listed in API docs
• -o OUTPUT_FORMAT, --output OUTPUT_FORMAT - Changes the output formats based on presets
• --host HOST - Extra host to be added
• --skip-reachability-check - if added skips reachability check of –host parameter
• --include INCLUDE - Include the extra host in the scope of the scan
• --name NAME - Display name of the extra host
• --description DESCRIPTION - Description of the extra host

probely targets add-extra-host Available Filters

• --f-has-unlimited-scans F_HAS_UNLIMITED_SCANS - Filter if target has unlimited scans
• --f-is-url-verified F_IS_URL_VERIFIED - Filter targets by verified (true) or not verified (false) domain
• --f-risk F_RISK - Filter targets by risk
• --f-type F_TYPE - Filter targets by type
• --f-search SEARCH_TERM - Filter Targets matching name, url or labels
• --f-label F_LABEL - Filter Targets by Targets Label IDs
• --f-label-logical-operator F_LABEL_LOGICAL_OPERATOR - Logical operator to apply when filtering labels
• --f-scan-profile F_SCAN_PROFILE - Filter Targets by Scan Profile identifiers

probely targets delete

Delete targets given by identifiers or the results of filters

probely targets delete [-h] [--api-key API_KEY] [--debug]
                       [--f-has-unlimited-scans {TRUE,FALSE}]
                       [--f-is-url-verified {TRUE,FALSE}]
                       [--f-risk {NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} [{NA,NO_RISK,LOW,MEDIUM,HIGH,CRITICAL} ...]]
                       [--f-type {WEB,API} [{WEB,API} ...]] [--f-search SEARCH_TERM]
                       [--f-label F_LABEL [F_LABEL ...]]
                       [--f-label-logical-operator {AND,OR}]
                       [--f-scan-profile F_SCAN_PROFILE [F_SCAN_PROFILE ...]]
                       [TARGET_ID ...]

probely targets delete positional arguments

• TARGET_ID - Identifiers of the targets to delete

probely targets delete 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

probely targets delete Available Filters

• --f-has-unlimited-scans F_HAS_UNLIMITED_SCANS - Filter if target has unlimited scans
• --f-is-url-verified F_IS_URL_VERIFIED - Filter targets by verified (true) or not verified (false) domain
• --f-risk F_RISK - Filter targets by risk
• --f-type F_TYPE - Filter targets by type
• --f-search SEARCH_TERM - Filter Targets matching name, url or labels
• --f-label F_LABEL - Filter Targets by Targets Label IDs
• --f-label-logical-operator F_LABEL_LOGICAL_OPERATOR - Logical operator to apply when filtering labels
• --f-scan-profile F_SCAN_PROFILE - Filter Targets by Scan Profile identifiers