Skip to content
Go to file

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


Ruby command-line interface to Burp Suite's REST API


burpcommander VERSION: 1.0.1  -  UPDATED: 08/29/2018

	-t, --target [IP Address]           Defaults to
	-p, --port  [Port Number]           Defaults to 1337
	-k, --key [API Key]                 If you require an API key specify it here
	-i, --issue-type-id [String]        String to search for.  Example: "1048832"
	-n, --issue-name [String]           String to search for.  Example: "Command Injection"
	-D, --DESCRIPTION                   Returns the description of a requested issue
	-M, --METRICS                       Returns the scan_metrics for a given task_id
	-I, --ISSUES [Optional Number]      Returns the issue_events of a given task_id
	-s, --scan [Complete URL]           Example:
	-S, --scan-id [Number]              Returns ScanProgress for a given task_id
	-U, --username [String]             Username to supply for an authenticated scan
	-P, --password [String]             Password to supply for an authenticated scan
    -x, --proxy [Proxy HOST:PORT]       Example:
        --proxy-username [Proxy user]   Proxy username (if any)
        --proxy-password [Proxy pass]   Proxy password (if any)
	-v, --verbose                       Enables verbose output

Generic Example

./burpcommander.rb -k [API Key] -n "command injection" -D

Command Output

Operating system command injection vulnerabilities arise when an application incorporates user-controllable data into a command that is processed by a shell command interpreter. If the user data is not strictly validated, an attacker can use shell metacharacters to modify the command that is executed, and inject arbitrary further commands that will be executed by the server.

OS command injection vulnerabilities are usually very serious and may lead to compromise of the server hosting the application, or of the application's own data and functionality. It may also be possible to use the server as a platform for attacks against other systems. The exact potential for exploitation depends upon the security context in which the command is executed, and the privileges that this context has regarding sensitive resources on the server.

Launch a Scan

./burpcommander.rb -s -U admin -P password

I, [2018-08-29T15:27:09.310594 #18919]  INFO -- : Successfuly initiated task_id: 4 against

Launch a Scan with Proxy

./burpcommander.rb -s -U admin -P password -x --proxy-username user --proxy-password pass

I, [2018-09-26T10:30:39.540832 #3104]  INFO -- : Successfuly initiated task_id: 25 against

Query Scan Information

Get the scan_metrics of a given scan.

./burpcommander.rb -S 4 -M


Get issue number 1 from a given scan.

./burpcommander.rb -S 4 -I 1

{"name"=>"File upload functionality",
"The page contains a form which is used to submit a user-supplied...


Ruby command-line interface to Burp Suite's REST API



No releases published


No packages published


You can’t perform that action at this time.