Montoya API for Burp Suite Extensions

repository·main·Indexed 41 days ago

https://github.com/portswigger/burp-extensions-montoya-api

The modern interface for building Burp Suite extensions (BApps), providing programmatic access to Burp's core functionality. Includes guidance on implementing the BurpExtension interface and using the MontoyaApi instance for extension development.

Tokens
471
Snippets
2
Records
3
Agent score
3%

What's inside Montoya API

  1. Access Montoya API documentation and examples

    main

    For detailed technical specifications and practical implementation patterns, refer to the following resources:

    • Javadoc: Comprehensive API reference for all Montoya classes and methods.
    • Examples Repository: A collection of practical extension examples to demonstrate various use cases.
  2. Install the Montoya API via Maven or Gradle

    main

    To build Burp Suite extensions (BApps) using the Montoya API, add the following dependency to your build configuration. Ensure you use the version compatible with your target Burp Suite environment.

    ### Maven
    ```xml
    <dependency>
        <groupId>net.portswigger.burp.extensions</groupId>
        <artifactId>montoya-api</artifactId>
        <version>2026.7</version>
    </dependency>

    Gradle

    implementation 'net.portswigger.burp.extensions:montoya-api:2026.7'
  3. Get started with a Burp Extension

    main

    To create a new extension, you must implement the BurpExtension interface. The entry point for your extension is the initialize method, which provides an instance of MontoyaApi. This MontoyaApi instance is the primary gateway for interacting with and modifying Burp Suite's functionality.

    import burp.api.montoya.BurpExtension;
    import burp.api.montoya.MontoyaApi;
    
    public class MyExtension implements BurpExtension {
        @Override
        public void initialize(MontoyaApi api) {
            // Use the api instance to interact with Burp Suite
        }
    }