Skip to main content

Targets

probely targets - CLI interface​

Create, manage and scan targets

probely targets {get,add,update,start-scan,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} [{NA,NO_RISK,LOW,MEDIUM,HIGH} ...]]
                    [--f-type {WEB,API} [{WEB,API} ...]] [--f-search SEARCH_TERM]
                    [-o {YAML,JSON}]
                    [TARGET_ID [TARGET_ID ...]]

probely targets positional arguments​

  • TARGET_ID - Identifiers of the targets to list

probely targets optional arguments​

  • -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-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
  • -o OUTPUT, --output OUTPUT - Changes the output formats based on presets

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}]
                    [--target-name TARGET_NAME] [--target-type {WEB,API}]
                    [--api-schema-type {OPENAPI,POSTMAN}]
                    [--api-schema-file-url API_SCHEMA_FILE_URL]
                    [TARGET_URL]

probely targets positional arguments​

  • TARGET_URL - Url of target

probely targets optional arguments​

  • -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, --output OUTPUT - 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

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} [{NA,NO_RISK,LOW,MEDIUM,HIGH} ...]]
                       [--f-type {WEB,API} [{WEB,API} ...]] [--f-search SEARCH_TERM]
                       [-f YAML_FILE_PATH] [-o {YAML,JSON}]
                       [TARGET_ID [TARGET_ID ...]]

probely targets positional arguments​

  • TARGET_ID - Identifiers of the targets to update

probely targets optional arguments​

  • -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-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 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, --output OUTPUT - Changes the output formats based on presets

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} [{NA,NO_RISK,LOW,MEDIUM,HIGH} ...]]
                           [--f-type {WEB,API} [{WEB,API} ...]] [--f-search SEARCH_TERM]
                           [-f YAML_FILE_PATH] [-o {YAML,JSON}]
                           [TARGET_ID [TARGET_ID ...]]

probely targets positional arguments​

  • TARGET_ID - Identifiers of the targets to scan

probely targets optional arguments​

  • -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-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 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, --output OUTPUT - Changes the output formats based on presets

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} [{NA,NO_RISK,LOW,MEDIUM,HIGH} ...]]
                       [--f-type {WEB,API} [{WEB,API} ...]] [--f-search SEARCH_TERM]
                       [TARGET_ID [TARGET_ID ...]]

probely targets positional arguments​

  • TARGET_ID - Identifiers of the targets to delete

probely targets optional arguments​

  • -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-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