Misc user options
Last updated: October 14, 2021
Read time: 7 Minutes
These settings let you configure hotkeys for common actions. Numerous types of actions can be assigned a hotkey, in the following categories:
- Actions specific to an individual HTTP request or response, such as "Send to Repeater".
- Global actions, such as "Switch to Proxy".
- In-editor actions, such as "Cut" and "Undo".
A number of hotkeys are configured by default. Note that very many more actions are available to have a hotkey assigned, if you use them frequently.
All hotkeys must use the Control key (or the Command key on OSX), and may also use Shift and other available modifiers. Note that on some Windows installations the Ctrl+Alt combination is treated by Windows as equivalent to AltGr, and so may result in typed characters appearing when pressed in text fields.
Automatic project backup
Automatic project backup saves a copy of the Burp project file periodically in the background. The following options are available:
- Whether to perform automatic backup, and how frequently.
- Whether to include in-scope items only.
- Whether to show a progress dialog during backups.
- Whether to delete the backup file on clean shutdown of Burp.
REST API options
The REST API can be used by other tools to integrate with Burp Suite.
The REST API exposes sensitive functionality and data. You should not enable the REST API service on untrusted network interfaces, and you should use separate API keys for each client that you grant access to.
The following options are available:
- The URL on which the service runs. You can select the port number and interface to bind to. You should not bind to non-loopback interfaces when connected to untrusted networks.
- Whether the service is currently running.
- Whether to allow access without an API key. This option is not recommended. It means that anyone with network access to the service endpoint is able to trigger actions within Burp and access its data. This includes CSRF requests from untrusted websites that you browse on the same machine as Burp, so API keys should always be used even when the service is listening only the loopback interface.
- The API keys for use by clients. You can create separate API keys for different purposes, and selectively enable or disable them. API keys are secrets and should be handled carefully. Note that you can only retrieve the value of an API key at the time that it is created.
Once the service is configured, you can browse the API documentation and interact with the API at [Service URL]/[API key].
This option lets you configure whether Proxy interception should be enabled when Burp is started up. You can choose to always enable interception, always disable interception, or to restore the setting from when Burp was last closed.
Proxy history logging
This option controls whether adding items to Target scope will automatically set the Proxy option to stop sending out-of-scope items to the history or live tasks. Setting Burp to do this is useful to avoid accumulating project data for out-of-scope items.
Temporary files location
These settings let you configure where Burp stores its temporary files.
By default, Burp creates a directory within the temporary file location provided by the platform. You can modify this behavior to use a custom directory - for example, on a different volume, or which is not world-readable.
On Mac OS X, you may find that the default temporary file location is sometimes cleared following system hibernation, causing Burp to lose its temporary files. You can resolve this problem by configuring a custom location for Burp to store its temporary files.
Changes to this setting take effect the next time Burp starts up.
You can help improve Burp by submitting anonymous feedback about Burp's performance.
Feedback only contains technical information about Burp's internal functioning, and does not identify you in any way. If you do report a bug, you can help us diagnose any problems that your instance of Burp has encountered by including your debug ID.
Logging exceptions to a local directory
In some cases, it may not be possible for us to receive data about your performance issues even if you do enable anonymous feedback. For example, if you have a strict security policy, it might block data from being sent to our support team. In this case, we might ask you to temporarily activate the "Log exceptions to a local directory" option and attempt to replicate the issue.
While this option is active, exceptions are logged to a local file in the specified directory. Therefore, if you can replicate the issue, you can manually send a copy of your local log file to our support team to help them identify the problem. The file name is a combination of the current date and your debug ID, which identifies the session in which the exception was raised. Each instance of Burp generates its own log.
The log entries only contain the time of the exception, a brief description, and a stack trace. The stack trace is fully obfuscated, so no personal data can be read from the file.
If you change the directory where the log should be saved, make sure that the user who is replicating the issue has write access for the specified directory. Otherwise, the file will not be generated.
By default, Burp will automatically download any available updates. When a new update has been downloaded, a notification will prompt you to restart Burp in order to install it. You can also click "More information" to see a summary of the most important changes and access the full release notes.
If you close the notification or select "Not now" from the "More information" dialog, the update will be installed the next time you manually restart Burp.
You can choose whether updates are downloaded from the Stable or Early Adopter channel. New features and other improvements to Burp Suite are first released to the Early Adopter channel. Early Adopter versions are released to the Stable channel when any initial problems have been resolved. By default, all installations of Burp will update from the Stable channel. However, you can also manually select which channel you want to use for each installation.
You can still manually download any version of Burp Suite from our website. However, please be aware that if you manually download and install a version that is only available on the Early Adopter channel, your update channel will automatically be switched to Early Adopter.
If you revert to an older version of Burp Suite, such as moving from the Early Adopter channel to the Stable channel and downloading an earlier Stable version, project files will not necessarily work with the earlier version. Burp will warn you that your project files are likely to be incompatible with the current installation, and it is possible to damage project files by doing this. We recommend using only new project files when moving to an older version of Burp Suite.
If you prefer, you can disable auto-updates by deselecting the "Enable auto-updates" checkbox. In this case, you will be informed when an update is available but can choose not to download or install it.
Please be aware that, unlike other user options, update settings are applied only to the current installation of Burp. If you use multiple installations, you need to change these settings for each of them. This allows a user to have both a Stable and an Early Adopter version of Burp Suite installed at the same time.
The auto-update feature is not available if you launch Burp from a JAR file.
These settings control the defaults for the search bar at the bottom of the message editor window. Each of the options can be toggled on or off from the settings cog icon on the search bar itself, but the options here control what defaults are used for the following settings:
- Case sensitive - This specifies whether the default search is case sensitive or insensitive.
- Regex - This specifies whether the default search term is a regular expression or a literal string.
- Auto-scroll to match when text changes - This specifies whether the text editor should by default automatically scroll to the first highlighted match when new text is displayed. This is useful, for example, when stepping through items in the Proxy history looking for a particular expression in responses. If this option is selected, then when you select a new item, the display will automatically scroll to the first search match.
This option determines whether your preferences and history in Burp's embedded Chromium browser are persistent. This is enabled by default, which means you can configure Chromium however you like, and even install your favorite extensions, and these changes will be recovered each time you open the embedded browser.
If you disable this option, the embedded browser will always open in a completely clean state. Any changes you make to the preferences will be lost when you close Chromium and you will need to reinstall your extensions every time you launch the browser.