Package org.zaproxy.clientapi.gen

Class Exim

  • public class Exim
extends java.lang.Object
    This file was automatically generated.

    • Constructor Summary

      Constructors 
      Constructor Description
      Exim​(ClientApi api)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte[] exportHar​(java.lang.String baseurl, java.lang.String start, java.lang.String count)
      Gets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages
      byte[] exportHarById​(java.lang.String ids)
      Gets the HTTP messages with the given IDs, in HAR format.
      ApiResponse exportSitesTree​(java.lang.String filepath)
      Exports the Sites Tree in the Sites Tree YAML format.
      ApiResponse importHar​(java.lang.String filepath)
      Imports a HAR file.
      ApiResponse importModsec2Logs​(java.lang.String filepath)
      Imports ModSecurity2 logs from the file with the given file system path.
      ApiResponse importUrls​(java.lang.String filepath)
      Imports URLs (one per line) from the file with the given file system path.
      ApiResponse importZapLogs​(java.lang.String filepath)
      Imports previously exported ZAP messages from the file with the given file system path.
      ApiResponse pruneSitesTree​(java.lang.String filepath)
      Prunes the Sites Tree based on a file in the Sites Tree YAML format.
      byte[] sendHarRequest​(java.lang.String request, java.lang.String followredirects)
      Sends the first HAR request entry, optionally following redirections.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • importUrls

        public ApiResponse importUrls​(java.lang.String filepath)
                       throws ClientApiException
        Imports URLs (one per line) from the file with the given file system path.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • importZapLogs

        public ApiResponse importZapLogs​(java.lang.String filepath)
                          throws ClientApiException
        Imports previously exported ZAP messages from the file with the given file system path.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • importModsec2Logs

        public ApiResponse importModsec2Logs​(java.lang.String filepath)
                              throws ClientApiException
        Imports ModSecurity2 logs from the file with the given file system path.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • exportSitesTree

        public ApiResponse exportSitesTree​(java.lang.String filepath)
                            throws ClientApiException
        Exports the Sites Tree in the Sites Tree YAML format.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • pruneSitesTree

        public ApiResponse pruneSitesTree​(java.lang.String filepath)
                           throws ClientApiException
        Prunes the Sites Tree based on a file in the Sites Tree YAML format.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • exportHar

        public byte[] exportHar​(java.lang.String baseurl,
                        java.lang.String start,
                        java.lang.String count)
                 throws ClientApiException
        Gets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • exportHarById

        public byte[] exportHarById​(java.lang.String ids)
                     throws ClientApiException
        Gets the HTTP messages with the given IDs, in HAR format.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • sendHarRequest

        public byte[] sendHarRequest​(java.lang.String request,
                             java.lang.String followredirects)
                      throws ClientApiException
        Sends the first HAR request entry, optionally following redirections. Returns, in HAR format, the request sent and response received and followed redirections, if any. The Mode is enforced when sending the request (and following redirections), custom manual requests are not allowed in 'Safe' mode nor in 'Protected' mode if out of scope.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException