Package org.zaproxy.clientapi.gen

Class Spider

  • public class Spider
extends SpiderDeprecated
    This file was automatically generated.

    • Constructor Detail

    • Method Detail

      • excludedFromScan

        public ApiResponse excludedFromScan()
                             throws ClientApiException
        Gets the regexes of URLs excluded from the spider scans.

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

        Throws:
        ClientApiException

      • allUrls

        public ApiResponse allUrls()
                    throws ClientApiException
        Returns a list of unique URLs from the history table based on HTTP messages added by the Spider.

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

        Throws:
        ClientApiException

      • addedNodes

        public ApiResponse addedNodes​(java.lang.String scanid)
                       throws ClientApiException
        Returns a list of the names of the nodes added to the Sites tree by the specified scan.

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

        Throws:
        ClientApiException

      • domainsAlwaysInScope

        public ApiResponse domainsAlwaysInScope()
                                 throws ClientApiException
        Gets all the domains that are always in scope. For each domain the following are shown: the index, the value (domain), if enabled, and if specified as a regex.

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

        Throws:
        ClientApiException

      • optionDomainsAlwaysInScope

        @Deprecated
public ApiResponse optionDomainsAlwaysInScope()
                                       throws ClientApiException
        Deprecated.
        Use view domainsAlwaysInScope instead.

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

        Throws:
        ClientApiException

      • optionDomainsAlwaysInScopeEnabled

        @Deprecated
public ApiResponse optionDomainsAlwaysInScopeEnabled()
                                              throws ClientApiException
        Deprecated.
        Use view domainsAlwaysInScope instead.

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

        Throws:
        ClientApiException

      • optionMaxChildren

        public ApiResponse optionMaxChildren()
                              throws ClientApiException
        Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.

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

        Throws:
        ClientApiException

      • optionMaxDepth

        public ApiResponse optionMaxDepth()
                           throws ClientApiException
        Gets the maximum depth the spider can crawl, 0 if unlimited.

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

        Throws:
        ClientApiException

      • optionMaxParseSizeBytes

        public ApiResponse optionMaxParseSizeBytes()
                                    throws ClientApiException
        Gets the maximum size, in bytes, that a response might have to be parsed.

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

        Throws:
        ClientApiException

      • optionAcceptCookies

        public ApiResponse optionAcceptCookies()
                                throws ClientApiException
        Gets whether or not a spider process should accept cookies while spidering.

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

        Throws:
        ClientApiException

      • optionSendRefererHeader

        public ApiResponse optionSendRefererHeader()
                                    throws ClientApiException
        Gets whether or not the 'Referer' header should be sent while spidering.

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

        Throws:
        ClientApiException

      • scan

        public ApiResponse scan​(java.lang.String url,
                        java.lang.String maxchildren,
                        java.lang.String recurse,
                        java.lang.String contextname,
                        java.lang.String subtreeonly)
                 throws ClientApiException
        Runs the spider against the given URL (or context). Optionally, the 'maxChildren' parameter can be set to limit the number of children scanned, the 'recurse' parameter can be used to prevent the spider from seeding recursively, the parameter 'contextName' can be used to constrain the scan to a Context and the parameter 'subtreeOnly' allows to restrict the spider under a site's subtree (using the specified 'url').

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

        Throws:
        ClientApiException

      • scanAsUser

        public ApiResponse scanAsUser​(java.lang.String contextid,
                              java.lang.String userid,
                              java.lang.String url,
                              java.lang.String maxchildren,
                              java.lang.String recurse,
                              java.lang.String subtreeonly)
                       throws ClientApiException
        Runs the spider from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.

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

        Throws:
        ClientApiException

      • clearExcludedFromScan

        public ApiResponse clearExcludedFromScan()
                                  throws ClientApiException
        Clears the regexes of URLs excluded from the spider scans.

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

        Throws:
        ClientApiException

      • excludeFromScan

        public ApiResponse excludeFromScan​(java.lang.String regex)
                            throws ClientApiException
        Adds a regex of URLs that should be excluded from the spider scans.

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

        Throws:
        ClientApiException

      • addDomainAlwaysInScope

        public ApiResponse addDomainAlwaysInScope​(java.lang.String value,
                                          java.lang.String isregex,
                                          java.lang.String isenabled)
                                   throws ClientApiException
        Adds a new domain that's always in scope, using the specified value. Optionally sets if the new entry is enabled (default, true) and whether or not the new value is specified as a regex (default, false).

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

        Throws:
        ClientApiException

      • modifyDomainAlwaysInScope

        public ApiResponse modifyDomainAlwaysInScope​(java.lang.String idx,
                                             java.lang.String value,
                                             java.lang.String isregex,
                                             java.lang.String isenabled)
                                      throws ClientApiException
        Modifies a domain that's always in scope. Allows to modify the value, if enabled or if a regex. The domain is selected with its index, which can be obtained with the view domainsAlwaysInScope.

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

        Throws:
        ClientApiException

      • removeDomainAlwaysInScope

        public ApiResponse removeDomainAlwaysInScope​(java.lang.String idx)
                                      throws ClientApiException
        Removes a domain that's always in scope, with the given index. The index can be obtained with the view domainsAlwaysInScope.

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

        Throws:
        ClientApiException

      • enableAllDomainsAlwaysInScope

        public ApiResponse enableAllDomainsAlwaysInScope()
                                          throws ClientApiException
        Enables all domains that are always in scope.

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

        Throws:
        ClientApiException

      • disableAllDomainsAlwaysInScope

        public ApiResponse disableAllDomainsAlwaysInScope()
                                           throws ClientApiException
        Disables all domains that are always in scope.

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

        Throws:
        ClientApiException

      • setOptionHandleParameters

        public ApiResponse setOptionHandleParameters​(java.lang.String string)
                                      throws ClientApiException
        This component is optional and therefore the API will only work if it is installed
        Throws:
        ClientApiException

      • setOptionAcceptCookies

        public ApiResponse setOptionAcceptCookies​(boolean bool)
                                   throws ClientApiException
        Sets whether or not a spider process should accept cookies while spidering.

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

        Throws:
        ClientApiException

      • setOptionHandleODataParametersVisited

        public ApiResponse setOptionHandleODataParametersVisited​(boolean bool)
                                                  throws ClientApiException
        This component is optional and therefore the API will only work if it is installed
        Throws:
        ClientApiException

      • setOptionMaxChildren

        public ApiResponse setOptionMaxChildren​(int i)
                                 throws ClientApiException
        Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.

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

        Throws:
        ClientApiException

      • setOptionMaxDepth

        public ApiResponse setOptionMaxDepth​(int i)
                              throws ClientApiException
        Sets the maximum depth the spider can crawl, 0 for unlimited depth.

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

        Throws:
        ClientApiException

      • setOptionMaxParseSizeBytes

        public ApiResponse setOptionMaxParseSizeBytes​(int i)
                                       throws ClientApiException
        Sets the maximum size, in bytes, that a response might have to be parsed. This allows the spider to skip big responses/files.

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

        Throws:
        ClientApiException

      • setOptionSendRefererHeader

        public ApiResponse setOptionSendRefererHeader​(boolean bool)
                                       throws ClientApiException
        Sets whether or not the 'Referer' header should be sent while spidering.

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

        Throws:
        ClientApiException