Skip to main content
  1. Tool Start Parameters
  2. Sniper

Sniper

Request parameters

Parameters
Parameter
tool_id
Type
integer required
true
The ID of this tool. The value is 490.
Parameter
target
Type
string required
true
The IP address or hostname that will be scanned.
Parameter
tool_params
Type
dictionary
Parameter
tool_params.auth_type
Type
boolean | string
default
 
false
The type of scan that you want to be performed. The value can be "sniper_auth" or false.
Parameter
tool_params.port_type
Type
string
default
 
"common_ports"
Port type. The value can be "common_ports", "port_range" or "port_list".
Parameter
tool_params.commonms
Type
string
default
 
"Top 100 ports"
Type of common ports. Used when port_type is set to "common_ports". The value can be "Top 10 ports", "Top 100 ports", "Top 1000 ports" or "Top 5000 ports".
Parameter
tool_params.start_port
Type
integer
Start port used when port_type is set to "port_range".
Parameter
tool_params.end_port
Type
integer
Start port used when port_type is set to "port_range".
Parameter
tool_params.list_of_ports
Type
string
Comma separated list of ports. Used when port_type is set to "port_list". Example: "22,53,443".
Parameter
tool_params.protocol_input
Type
string
Protocol type used when auth_type is set to "sniper_auth". The value can be "ssh" or "winrm".
Parameter
tool_params.port_input
Type
string
Port used when auth_type is set to "sniper_auth". Example: "22".
Parameter
tool_params.username_input
Type
string
Username used when auth_type is set to "sniper_auth". Example: "admin".
Parameter
tool_params.password_input
Type
string
Password used when auth_type is set to "sniper_auth". Example: "password".
Parameter
tool_params.private_key_input
Type
string
SSH key used when auth_type is set to "sniper_auth" and protocol_input is set to "ssh". Example: "password".
Parameter
tool_params.auth_type_input
Type
string
Authentication used when auth_type is set to "sniper_auth" and protocol_input is set to "wirm". The value can be "ntlm" or "basic".
{
  "op": "start_scan",
  "tool_id": 490,
  "target": "demo.pentest-tools.com",
  "tool_params": {
    "port_type": "common_ports",
    "commons": "Top 1000 ports"
  }
}
{
  "op": "start_scan_by_targetid",
  "tool_id": 490,
  "target_id": 7585431,
  "tool_params": {
    "port_type": "port_list",
    "list_of_ports": "22, 3389, 8080-8081"
  }
}