Package burp.api.montoya.burpsuite

Interface BurpSuite

  • public interface BurpSuite
    This interface provides access to functionality related to the Burp Suite application.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> commandLineArguments()
      This method returns the command line arguments that were passed to Burp on startup.
      java.lang.String exportProjectOptionsAsJson​(java.lang.String... paths)
      This method causes Burp to save its current project-level configuration in JSON format.
      void importProjectOptionsFromJson​(java.lang.String json)
      This method causes Burp to load a new project-level configuration from the JSON String provided.
      void shutdown​(ShutdownOptions... options)
      This method can be used to shut down Burp programmatically.
      Version version()
      This method retrieves information about the version of Burp in which the extension is running.

    • Method Detail

      • version

        Version version()
        This method retrieves information about the version of Burp in which the extension is running. It can be used by extensions to dynamically adjust their behavior depending on the functionality and APIs supported by the current version.
        Returns:
        The Burp Version.

      • exportProjectOptionsAsJson

        java.lang.String exportProjectOptionsAsJson​(java.lang.String... paths)
        This method causes Burp to save its current project-level configuration in JSON format. This is the same format that can be saved and loaded via the Burp user interface. To include only certain sections of the configuration, you can optionally supply the path to each section that should be included, for example: "project_options.connections". If no paths are provided, then the entire configuration will be saved.
        Parameters:
        paths - A list of Strings representing the path to each configuration section that should be included.
        Returns:
        A String representing the current configuration in JSON format.

      • importProjectOptionsFromJson

        void importProjectOptionsFromJson​(java.lang.String json)
        This method causes Burp to load a new project-level configuration from the JSON String provided. This is the same format that can be saved and loaded via the Burp user interface. Partial configurations are acceptable, and any settings not specified will be left unmodified.

        Any user-level configuration options contained in the input will be ignored.

        Parameters:
        json - A JSON String containing the new configuration.

      • commandLineArguments

        java.util.List<java.lang.String> commandLineArguments()
        This method returns the command line arguments that were passed to Burp on startup.
        Returns:
        The command line arguments that were passed to Burp on startup.

      • shutdown

        void shutdown​(ShutdownOptions... options)
        This method can be used to shut down Burp programmatically.
        Parameters:
        options - The shutdown options for shutting down Burp programmatically. For example ShutdownOptions.PROMPT_USER will display a dialog to the user allowing them to confirm or cancel the shut down.