All Classes and Interfaces

Class	Description
ActionResult	An instance of this interface should be returned by SessionHandlingAction.performAction(SessionHandlingActionData).
Annotations	Annotations stored with requests and responses in Burp Suite.
AttackConfiguration	Intruder attack configuration.
Attribute	Burp attribute able to retrieve to hold details about HTTP response attributes.
AttributeType	Otions that Burp can use to query attributes of HTTP responses.
Audit	Audit in the Burp Scanner tool.
AuditConfiguration	This class represents the configuration required for an audit in the Burp Scanner Tool.
AuditInsertionPoint	This interface is used to define an insertion point for use by active Scan checks.
AuditInsertionPointProvider	Extensions can implement this interface and then call Scanner.registerInsertionPointProvider(AuditInsertionPointProvider) to register a provider for custom audit insertion points.
AuditInsertionPointType	This enum represents the audit insertion point type.
AuditIssue	This interface is used to retrieve details of audit issues.
AuditIssueConfidence	This enum represents the confidence level of an audit issue.
AuditIssueContextMenuEvent
AuditIssueDefinition	This interface is used to retrieve background information about audit issues.
AuditIssueHandler	Extensions can implement this interface and then call Scanner.registerAuditIssueHandler(AuditIssueHandler) to register an audit issue handler.
AuditIssueSeverity	This enum represents the severity level of an audit issue.
AuditResult
Base64DecodingOptions	This enum defines HTML encodings.
Base64EncodingOptions	This enum defines HTML encodings.
Base64Utils	This interface contains various methods that give you access to base64 encoding and decoding features.
BasicMenuItem
BCheckImportResult	The result of importing a BCheck
BCheckImportResult.Status	The status of an imported BCheck
BChecks	Provides access to functionality related to BChecks.
BinaryMessage
BinaryMessageAction	Binary WebSocket message.
BinaryMessageReceivedAction	Extensions can implement this interface when returning a binary message from ProxyMessageHandler.handleBinaryMessageReceived(InterceptedBinaryMessage).
BinaryMessageToBeSentAction	Extensions can implement this interface when returning a binary message from ProxyMessageHandler.handleBinaryMessageToBeSent(InterceptedBinaryMessage).
BuiltInAuditConfiguration	This enum represents built in configurations for the Burp Scanner tool.
BurpExtension	All extensions must implement this interface.
BurpSuite	Provides access to functionality related to the Burp Suite application.
BurpSuiteEdition	Editions of Burp Suite.
ByteArray	Burp ByteArray with various methods for querying and manipulating byte arrays.
ByteUtils	This interface gives you access to various methods for querying and manipulating byte arrays.
Collaborator	[Professional only] Provides access to the facilities of Burp Collaborator.
CollaboratorClient	Burp Collaborator client that can be used to generate Burp Collaborator payloads and poll the Collaborator server for any network interactions that result from using those payloads.
CollaboratorPayload	Burp Collaborator payload.
CollaboratorPayloadGenerator	Burp Collaborator payload generator that can be used to generate Burp Collaborator payloads.
CollaboratorServer	Provides details of the Collaborator server associated with this client.
Comparer	Provides access to the functionality of the Comparer tool.
ComponentEvent	This interface describes an action or event that has occurred with a user interface component.
CompressionType	This enum defines available compression types.
CompressionUtils	This interface gives you access to data compression features.
ConsolidationAction	This enum represents the action to be taken when duplicate audit issues are found.
ContentType	Content types recognised by Burp.
ContextMenuEvent	Provides useful information when generating context menu items from a ContextMenuItemsProvider.
ContextMenuItemsProvider	This interface allows extensions to implement and register a provider for custom context menu items.
Cookie	Burp cookie able to retrieve and hold details about a cookie.
CookieJar	Provides access to Burp's Cookie Jar functionality.
Crawl	Crawl in the Burp Scanner tool.
CrawlAndAudit	Crawl and audit in the Burp Scanner tool.
CrawlConfiguration	This class represents the configuration required for an crawl in the Burp Scanner Tool.
CryptoUtils	This interface gives you access to cryptographic features.
Decoder	Provides access to the functionality of the Decoder tool.
DigestAlgorithm	Enum of available message digest algorithms.
Direction	This enum is used to indicate the direction of the WebSocket message.
DnsDetails	Provides information about a DNS interaction detected by Burp Collaborator.
DnsQueryType	Domain Name System (DNS) query types.
Editor	Provides the shared behaviour between the different editor types.
EditorCreationContext	This interface is used by an ExtensionHttpRequestEditor or ExtensionHttpResponseEditor to obtain details about the currently displayed message.
EditorMode	An enum to describe the different modes of Burp Suites message editor.
EditorOptions	These options allow you to configure additional behaviour to Editor implementations.
Extension	Provides access to functionality related to your Extension.
ExtensionProvidedEditor	Provides the shared behaviour between the different extension provided editor types.
ExtensionProvidedHttpRequestEditor	Extensions that register an HttpRequestEditorProvider must return an instance of this interface. Burp will then use that instance to create custom tabs within its HTTP request editor.
ExtensionProvidedHttpResponseEditor	Extensions that register an HttpResponseEditorProvider must return an instance of this interface. Burp will then use that instance to create custom tabs within its HTTP response editor.
ExtensionProvidedWebSocketMessageEditor	Extensions that register an WebSocketMessageEditorProvider must return an instance of this interface. Burp will then use that instance to create custom tabs within its Web Socket message editor.
ExtensionUnloadingHandler	Extensions can implement this interface and then call Extension.registerUnloadingHandler(ExtensionUnloadingHandler) to register an extension unload handler.
ExtensionWebSocket	A WebSocket created via the Extension API.
ExtensionWebSocketCreation	Result of a WebSocket creation attempt
ExtensionWebSocketCreationStatus	Status of a WebSocket creation attempt
ExtensionWebSocketMessageHandler	This interface allows an extension to be notified when messages are received or the WebSocket has been closed.
GeneratedPayload	Intruder payload.
HighlightColor	Colors that can be used for highlights in Burp Suite.
HtmlEncoding	This enum defines HTML encodings.
HtmlUtils	This interface gives you access to HTML encoding and decoding features.
Http	Provides access HTTP related functionality of Burp.
HttpDetails	Provides information about an HTTP interaction detected by Burp Collaborator.
HttpHandler	Extensions can implement this interface and then call Http.registerHttpHandler(burp.api.montoya.http.handler.HttpHandler) to register an HTTP handler.
HttpHeader	Burp HTTP header able to retrieve to hold details about an HTTP header.
HttpMessage	Burp message retrieve common information shared by HttpRequest and HttpResponse.
HttpMode	HTTP modes when sending a request.
HttpParameter	Burp HTTP parameter able to retrieve to hold details about an HTTP request parameter.
HttpParameterType	HTTP parameter types.
HttpProtocol	HTTP protocols.
HttpRequest	Burp HTTP request able to retrieve and modify details of an HTTP request.
HttpRequestEditor	Provides extensions with an instance of Burp Suites HTTP request editor to use in their own user interface.
HttpRequestEditorProvider	Extensions can register an instance of this interface to provide custom HTTP request editors within Burp's user interface.
HttpRequestResponse	This interface is used to define a coupling between HttpRequest and HttpResponse.
HttpRequestTemplate	Intruder request template, which contains the HTTP request and insertion point offsets.
HttpRequestTemplateGenerationOptions	Options that can be used to generate a new HttpRequestTemplate.
HttpRequestToBeSent	Burp HttpRequest with additional methods to retrieve Annotations and ToolSource of the request.
HttpResponse	Burp HTTP response able to retrieve and modify details about an HTTP response.
HttpResponseEditor	Provides extensions with an instance of Burp Suites HTTP response editor to use in their own user interface.
HttpResponseEditorProvider	Extensions can register an instance of this interface to provide custom HTTP response editors within Burp's user interface.
HttpResponseReceived	Burp HttpResponse with additional methods to retrieve initiating HttpRequest as well as the Annotations and ToolSource of the request.
HttpService	Burp HTTP service providing details about an HTTP service, to which HTTP requests can be sent.
HttpTransformation	This enum defines transformations that Burp can apply to an HTTP request.
Interaction	Provides details of an interaction with the Burp Collaborator server.
InteractionFilter	Provides a filtering mechanism for use when retrieving interactions from the Burp Collaborator server.
InteractionId	Burp Collaborator interaction id.
InteractionType	Possible types of interaction with Burp Collaborator.
InterceptedBinaryMessage
InterceptedHttpMessage	HTTP message intercepted by Burp Proxy.
InterceptedRequest	HTTP request intercepted by Burp Proxy.
InterceptedResponse	HTTP response intercepted by Burp Proxy.
InterceptedTextMessage
Intruder	Provides access to the functionality of the Burp Intruder tool.
IntruderInsertionPoint	Intruder insertion point for attack payloads.
InvocationSource	Provides information about the source from which a context menu was invoked.
InvocationType	An enum containing different types of context menu invocations.
KeywordCount	Stores the number of types a given keyword appeared in a response.
LoggerHttpRequestResponse	This interface is used to define a coupling between HttpRequest and HttpResponse for the Logger.
Logging	Provides access to the functionality related to logging and events.
MalformedRequestException	This class represents an exception which is thrown when trying to retrieve attributes from a malformed request.
Marker	Marker containing a range representing interesting data in requests and responses.
Menu	A menu to be displayed in the MenuBar.
MenuBar	The top menu bar for the main suite frame.
MenuItem	An item to be displayed in a Menu.
MessageAction	This enum represents the action to be applied to a TextMessageAction or BinaryMessageAction.
MessageEditorHttpRequestResponse	This class contains information about a user selection of a request or response within a Burp Suite message editor.
MessageEditorHttpRequestResponse.SelectionContext
MessageHandler	This interface allows an extension to be notified when messages are received or the WebSocket has been closed.
MessageReceivedAction	This enum represents the initial action to be taken when intercepting HTTP and WebSocket messages in the Proxy.
MessageToBeSentAction	This enum represents the final action to be taken when intercepting HTTP and WebSocket messages in the Proxy.
MimeType	MIME types that are recognised by Burp.
MontoyaApi	This interface is used by Burp Suite to pass a set of methods to extensions that can be used to perform various actions within Burp.
MontoyaObjectFactory
NumberUtils	This interface gives you access to number string conversion features.
ObjectFactoryLocator
Organizer	Provides access to the functionality of the Organizer tool.
ParsedHttpParameter	Burp HttpParameter with additional details about an HTTP request parameter that has been parsed by Burp.
PayloadData	Contains information about the payload
PayloadGenerator	Intruder payload generator.
PayloadGeneratorProvider	Extensions can implement this interface and then call Intruder.registerPayloadGeneratorProvider(burp.api.montoya.intruder.PayloadGeneratorProvider) to register a provider for custom Intruder payload generators.
PayloadOption	Options that can be specified when generating Burp Collaborator payloads.
PayloadProcessingAction	Instructions that the payload processor can give Intruder for the current payload.
PayloadProcessingResult	An instance of this interface should be returned by PayloadProcessor.processPayload(burp.api.montoya.intruder.PayloadData) if a custom PayloadProcessor was registered with Intruder.
PayloadProcessor	Extensions can implement this interface and then call Intruder.registerPayloadProcessor(burp.api.montoya.intruder.PayloadProcessor) to register a custom Intruder payload processor.
PersistedList<T>	List that has been persisted in the project.
PersistedObject	[Professional only] Enables data to be stored and accessed from the Burp project.
Persistence	Provides access to the persistence functionality.
Preferences	Enables data to be stored and accessed from the Java preference store.
Proxy	Provides access to the functionality of the Proxy tool.
ProxyHistoryFilter	Extensions can implement this interface and then call Proxy.history(ProxyHistoryFilter) to get a filtered list of items in the Proxy history.
ProxyHttpRequestResponse	HTTP request and response intercepted by the Proxy.
ProxyMessageHandler	This interface allows an extension to be notified when messages are sent or received via the proxy WebSocket, or it has been closed.
ProxyRequestHandler	Extensions can implement this interface and then call Proxy.registerRequestHandler(ProxyRequestHandler) to register a Proxy request handler.
ProxyRequestReceivedAction	Extensions can implement this interface when returning a result from ProxyRequestHandler.handleRequestReceived(InterceptedRequest).
ProxyRequestToBeSentAction	Extensions can implement this interface when returning a result from ProxyRequestHandler.handleRequestToBeSent(InterceptedRequest).
ProxyResponseHandler	Extensions can implement this interface and then call Proxy.registerResponseHandler(ProxyResponseHandler) to register a Proxy response handler.
ProxyResponseReceivedAction	Extensions can implement this interface when returning a result from ProxyResponseHandler.handleResponseReceived(InterceptedResponse).
ProxyResponseToBeSentAction	Extensions can implement this interface when returning a result from ProxyResponseHandler.handleResponseToBeSent(InterceptedResponse).
ProxyWebSocket	ProxyWebSocket within Burp.
ProxyWebSocketCreation	Information about the proxy web socket that is being created.
ProxyWebSocketCreationHandler	Extensions can implement this interface and then call Proxy.registerWebSocketCreationHandler(burp.api.montoya.proxy.websocket.ProxyWebSocketCreationHandler) to register a WebSocket handler. The handler will be notified of new WebSockets being created by the Proxy tool.
ProxyWebSocketHistoryFilter	Extensions can implement this interface and then call Proxy.webSocketHistory(ProxyWebSocketHistoryFilter) to get a filtered list of items in the Proxy WebSockets history.
ProxyWebSocketMessage	WebSocket message intercepted by the Proxy.
RandomUtils
RandomUtils.CharacterSet
Range	Range of integer values between two values in which the range includes the start value but excludes the end value.
RawEditor	Provides extensions with an instance of Burp Suite's HTTP text editor to use in their own user interface.
Registration	Returned when an object is registered by an extension in Burp Suite.
Repeater	Provides access to the functionality of the Repeater tool.
ReportFormat	This enum represents the formats for scan reports.
RequestAction	Action to be taken when intercepting HTTP requests.
RequestOptions	Interface used to specify options for making HTTP requests.
RequestToBeSentAction	An instance of this interface should be returned by HttpHandler.handleHttpRequestToBeSent(burp.api.montoya.http.handler.HttpRequestToBeSent) if a custom HttpHandler has been registered with Burp.
ResponseAction	Action to be taken when intercepting HTTP responses.
ResponseKeywordsAnalyzer	Analyze HTTP responses and retrieve keywords.
ResponseReceivedAction	An instance of this interface should be returned by HttpHandler.handleHttpResponseReceived(burp.api.montoya.http.handler.HttpResponseReceived) if a custom HttpHandler has been registered with Burp.
ResponseVariationsAnalyzer	Analyze HTTP responses and find variations between them, according to various attributes.
ScanCheck	Extensions can implement this interface and then call Scanner.registerScanCheck(ScanCheck) to register a custom Scanner check.
ScanConfiguration	Configurations for the Burp Scanner tool.
Scanner	[Professional only] Provides access to the functionality of the Scanner tool.
ScanTask	This interface is used to retrieve details of tasks in the Burp Scanner.
Scope	Provides access to the functionality related to Burp's Suite-wide target scope.
ScopeChange	Change to Burp's Suite-wide target scope.
ScopeChangeHandler	Extensions can implement this interface and then call Scope.registerScopeChangeHandler(ScopeChangeHandler) to register a scope change handler.
SecretKey	Secret key that is associated with a CollaboratorClient
Selection	Provides helpful information and functionality relating to a user's selection within the user interface.
SessionHandlingAction	Extensions can implement this interface and then call Http.registerSessionHandlingAction(burp.api.montoya.http.sessions.SessionHandlingAction) to register a custom session handling action.
SessionHandlingActionData	Information required for session handling.
ShutdownOptions	Shutdown options that can be used when calling BurpSuite.shutdown(ShutdownOptions...).
SiteMap	Provides methods for querying and modifying Burp's site map.
SiteMapFilter	This interface is used to filter items when querying Burp's site map.
SiteMapNode	This interface is used to represent items in the Burp's site map.
SmtpDetails	SMTP interaction detected by Burp Collaborator.
SmtpProtocol	Simple Mail Transfer Protocol (SMTP) protocols.
StatusCodeClass	Status code classes that are defined in the HTTP standard.
StringUtils	This interface gives you access to String manipulation features.
SwingUtils	This interface gives you access to swing utilities.
Task	Task on the Dashboard.
TaskExecutionEngine	Provides access to the task execution engine.
TaskExecutionEngine.TaskExecutionEngineState	Task execution engine state
TextMessage
TextMessageAction	Text WebSocket message.
TextMessageReceivedAction	Extensions can implement this interface when returning a text message from ProxyMessageHandler.handleTextMessageReceived(InterceptedTextMessage).
TextMessageToBeSentAction	Extensions can implement this interface when returning a text message from ProxyMessageHandler.handleTextMessageToBeSent(InterceptedTextMessage).
Theme	This enum contains the different themes available in Burp Suites user interface.
TimingData	Timing data
ToolSource	Tool that is the source of an object.
ToolType	Tools in Burp Suite.
URLUtils	This interface gives you access to URL encoding and decoding features.
UserInterface	This interface gives you access to various user interface related features.
Utilities	This interface gives you access to other interfaces that have various data conversion and querying features.
Version	Product version. e.g.
WebSocket	WebSocket within Burp.
WebSocketContextMenuEvent
WebSocketCreated
WebSocketCreatedHandler	Extensions can implement this interface and then call registerWebSocketCreatedHandler(burp.api.montoya.websocket.WebSocketCreatedHandler) to register a WebSocket handler.
WebSocketEditorEvent
WebSocketMessage
WebSocketMessageEditor	Provides extensions with an instance of Burp Suite's WebSocket message editor to use in their own user interface.
WebSocketMessageEditorProvider	Extensions can register an instance of this interface to provide custom Web Socket message editors within Burp's user interface.
WebSockets	Provides access to WebSocket related functionality of Burp.