Skip to content

Commit 8821959

Browse files
authored
Update README.md
1 parent 03c6c81 commit 8821959

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,17 @@ Since the first commit back in 2016, **burp-rest-api** has been the default tool
1313

1414
1) Download the latest *burp-rest-api* JAR (e.g. `burp-rest-api-2.3.2.jar`) from the [release page](https://github.com/vmware/burp-rest-api/releases)
1515
2) Place them within a directory having the **original** Burp Suite Professional JAR (e.g. *burpsuite_pro_v2025.6.3.jar*). **Important:** This is supposed to be the standalone JAR downloaded from https://portswigger.net/burp/releases. You should NOT use the `burpsuite_pro.jar` from a local Burp Suite installation
16-
3) On Java 21, run *burp-rest-api* using:
16+
3) Using **Java 21**, run *burp-rest-api*
1717

18-
On Linux, Mac `java --add-opens=java.desktop/javax.swing=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED -cp "burpsuite_pro.jar:burp-rest-api-2.3.2.jar" org.springframework.boot.loader.launch.JarLauncher`
18+
On Linux, Mac:
19+
```
20+
java --add-opens=java.desktop/javax.swing=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED -cp "burpsuite_pro.jar:burp-rest-api-2.3.2.jar" org.springframework.boot.loader.launch.JarLauncher
21+
```
1922

20-
On Windows `java --add-opens=java.desktop/javax.swing=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED -cp "burpsuite_pro.jar;burp-rest-api-2.3.2.jar" org.springframework.boot.loader.launch.JarLauncher`
23+
On Windows:
24+
```
25+
java --add-opens=java.desktop/javax.swing=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED -cp "burpsuite_pro.jar;burp-rest-api-2.3.2.jar" org.springframework.boot.loader.launch.JarLauncher
26+
```
2127

2228
**Important!!!**
2329
* Make sure to adjust the Burp Suite PRO and Burp Rest API JAR filenames
@@ -31,36 +37,29 @@ On Windows `java --add-opens=java.desktop/javax.swing=ALL-UNNAMED --add-opens=ja
3137

3238
By default, Burp is launched in headless mode with the Proxy running on port 8080/tcp (**localhost only**) and the REST endpoint running on 8090/tcp (**localhost only**).
3339

34-
To __run Burp in UI mode__ from the command line, use one of the following commands:
40+
To __run Burp in UI mode__ from the command line, append the following argument:
3541

3642
```
37-
./burp-rest-api.sh --headless.mode=false
43+
--headless.mode=false
3844
```
39-
40-
On Java <= 1.8, it is also possible to execute burp-rest-api in the following way:
41-
42-
```
43-
java -jar burp-rest-api-2.3.2.jar --headless.mode=false --burp.jar=./lib/burpsuite_pro.jar
44-
```
45-
46-
To __modify the server port__ on which the API is accessible, use one of the following commands:
45+
To __modify the server port__ on which the API is accessible, append the following argument:
4746

4847
```
49-
./burp-rest-api.sh --server.port=8081
48+
--server.port=8081
5049
```
5150
or
5251
```
53-
./burp-rest-api.sh --port=8081
52+
--port=8081
5453
```
5554

5655
You can also __modify the server address__, used for network address binding:
5756

5857
```
59-
./burp-rest-api.sh --server.address=192.168.1.2
58+
--server.address=192.168.1.2
6059
```
6160
or
6261
```
63-
./burp-rest-api.sh --address=192.168.1.2
62+
--address=192.168.1.2
6463
```
6564

6665
### Command Line Arguments

0 commit comments

Comments
 (0)