Index (zap-clientapi 1.7.0 API)

A B C D E F G H I J L M N O P R S T U V W X Z

A

accessUrl(String) - Method in class org.zaproxy.clientapi.core.ClientApi
accessUrl(String, String) - Method in class org.zaproxy.clientapi.gen.Core: Convenient and simple action to access a URL, optionally following redirections.
accessUrl(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
acsrf - Variable in class org.zaproxy.clientapi.core.ClientApi
Acsrf - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Acsrf(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Acsrf
AcsrfDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
AcsrfDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.AcsrfDeprecated
activeScanSiteInScope(String, String) - Method in class org.zaproxy.clientapi.core.ClientApi: Deprecated.
(1.1.0) Use ClientApi.activeScanSiteInScope(String) instead, the API key should be set using one of the ClientApi constructors.
activeScanSiteInScope(String) - Method in class org.zaproxy.clientapi.core.ClientApi: Active scans the given site, that's in scope.
activeSession(String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Gets the name of the active session for the given site.
addAlertFilter(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.AlertFilter: Adds a new alert filter for the context with the given ID.
addDefaultSessionToken(String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Adds a default session token with the given name and enabled state.
addDomainAlwaysInScope(String, String, String) - Method in class org.zaproxy.clientapi.gen.Spider: Adds a new domain that's always in scope, using the specified value.
addedNodes(String) - Method in class org.zaproxy.clientapi.gen.Spider: Returns a list of the names of the nodes added to the Sites tree by the specified scan.
addExcludedParam(String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan: Adds a new parameter excluded from the scan, using the specified name.
addExcludeFromContext(String, String, String) - Method in class org.zaproxy.clientapi.core.ClientApi: Deprecated.
(1.1.0) Use Context.excludeFromContext(String, String) instead.
addHttpBreakpoint(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Break: Adds a custom HTTP breakpont.
addHttpBreakpoint(String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.BreakDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
addIncludeInContext(String, String, String) - Method in class org.zaproxy.clientapi.core.ClientApi: Deprecated.
(1.1.0) Use Context.includeInContext(String, String) instead.
addItem(ApiResponse) - Method in class org.zaproxy.clientapi.core.ApiResponseList
addOptionToken(String) - Method in class org.zaproxy.clientapi.gen.Acsrf: Adds an anti-CSRF token with the given name, enabled by default
addOptionToken(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AcsrfDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
addProxyChainExcludedDomain(String, String, String) - Method in class org.zaproxy.clientapi.gen.Core: Adds a domain to be excluded from the outgoing proxy, using the specified value.
addRule(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Replacer: Adds a replacer rule.
addScanPolicy(String) - Method in class org.zaproxy.clientapi.gen.Ascan
addScanPolicy(String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan
addScanPolicy(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
addSessionToken(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.HttpSessionsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
addSessionToken(String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Adds the session token to the given site.
ajaxSpider - Variable in class org.zaproxy.clientapi.core.ClientApi
AjaxSpider - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
AjaxSpider(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.AjaxSpider
AjaxSpiderDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
AjaxSpiderDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated
Alert - Class in org.zaproxy.clientapi.core
Alert(ApiResponseSet) - Constructor for class org.zaproxy.clientapi.core.Alert: Constructs an Alert from the given ApiResponseSet.
Alert(String, String, String, String, String, String) - Constructor for class org.zaproxy.clientapi.core.Alert
Alert(String, String, Alert.Risk, Alert.Confidence, String, String, String, String, String, String, String, int, int) - Constructor for class org.zaproxy.clientapi.core.Alert
Alert(String, String, Alert.Risk, Alert.Confidence, String, String) - Constructor for class org.zaproxy.clientapi.core.Alert
Alert(String, String, Alert.Risk, Alert.Confidence) - Constructor for class org.zaproxy.clientapi.core.Alert
Alert(String, String) - Constructor for class org.zaproxy.clientapi.core.Alert
alert - Variable in class org.zaproxy.clientapi.core.ClientApi
Alert - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Alert(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Alert
alert(String) - Method in class org.zaproxy.clientapi.gen.Alert: Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method
alert(String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoint with the same name in the 'alert' component instead.
Alert.Confidence - Enum in org.zaproxy.clientapi.core
Alert.Reliability - Enum in org.zaproxy.clientapi.core: Deprecated.
(2.4.0) Replaced by Alert.Confidence. Use of reliability has been deprecated in favour of using confidence.
Alert.Risk - Enum in org.zaproxy.clientapi.core
alertCountsByRisk(String, String) - Method in class org.zaproxy.clientapi.gen.Alert: Gets a count of the alerts, optionally filtered as per alertsPerRisk
alertFilter - Variable in class org.zaproxy.clientapi.core.ClientApi
AlertFilter - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
AlertFilter(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.AlertFilter
alertFilterList(String) - Method in class org.zaproxy.clientapi.gen.AlertFilter: Lists the alert filters of the context with the given ID.
alerts(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Alert: Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts
alerts(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoint with the same name in the 'alert' component instead.
alerts(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Gets the alerts raised by ZAP, optionally filtering by URL and paginating with 'start' position and 'count' of alerts
alertsByRisk(String, String) - Method in class org.zaproxy.clientapi.gen.Alert: Gets a summary of the alerts, optionally filtered by a 'url'.
AlertsFile - Class in org.zaproxy.clientapi.core
AlertsFile() - Constructor for class org.zaproxy.clientapi.core.AlertsFile
alertsIds(String) - Method in class org.zaproxy.clientapi.gen.Ascan: Gets the IDs of the alerts raised during the scan with the given ID.
alertsSummary(String) - Method in class org.zaproxy.clientapi.gen.Alert: Gets number of alerts grouped by each risk level, optionally filtering by URL
alertsSummary(String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoint with the same name in the 'alert' component instead.
allSitesStats(String) - Method in class org.zaproxy.clientapi.gen.Stats: Gets all of the site based statistics, optionally filtered by a key prefix
allUrls() - Method in class org.zaproxy.clientapi.gen.Spider: Returns a list of unique URLs from the history table based on HTTP messages added by the Spider.
ApiResponse - Class in org.zaproxy.clientapi.core
ApiResponse(String) - Constructor for class org.zaproxy.clientapi.core.ApiResponse
ApiResponseElement - Class in org.zaproxy.clientapi.core
ApiResponseElement(String) - Constructor for class org.zaproxy.clientapi.core.ApiResponseElement
ApiResponseElement(String, String) - Constructor for class org.zaproxy.clientapi.core.ApiResponseElement
ApiResponseElement(Node, ApiResponse) - Constructor for class org.zaproxy.clientapi.core.ApiResponseElement
ApiResponseElement(Node) - Constructor for class org.zaproxy.clientapi.core.ApiResponseElement
ApiResponseFactory - Class in org.zaproxy.clientapi.core
ApiResponseList - Class in org.zaproxy.clientapi.core
ApiResponseList(String) - Constructor for class org.zaproxy.clientapi.core.ApiResponseList
ApiResponseList(Node) - Constructor for class org.zaproxy.clientapi.core.ApiResponseList
ApiResponseList(Node, ApiResponseList) - Constructor for class org.zaproxy.clientapi.core.ApiResponseList
ApiResponseList(String, ApiResponse[]) - Constructor for class org.zaproxy.clientapi.core.ApiResponseList
ApiResponseList(String, List<ApiResponse>) - Constructor for class org.zaproxy.clientapi.core.ApiResponseList
ApiResponseSet - Class in org.zaproxy.clientapi.core
ApiResponseSet(String, String[]) - Constructor for class org.zaproxy.clientapi.core.ApiResponseSet: Deprecated.
(1.1.0) Unused, there's no replacement.
ApiResponseSet(String, Map<String, ApiResponse>) - Constructor for class org.zaproxy.clientapi.core.ApiResponseSet
ApiResponseSet(Node) - Constructor for class org.zaproxy.clientapi.core.ApiResponseSet
ascan - Variable in class org.zaproxy.clientapi.core.ClientApi
Ascan - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Ascan(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Ascan
AscanDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
AscanDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated
attackModeQueue() - Method in class org.zaproxy.clientapi.gen.Ascan
authentication - Variable in class org.zaproxy.clientapi.core.ClientApi
Authentication - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Authentication(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Authentication
AuthenticationDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
AuthenticationDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.AuthenticationDeprecated
authorization - Variable in class org.zaproxy.clientapi.core.ClientApi
Authorization - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Authorization(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Authorization
AuthorizationDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
AuthorizationDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.AuthorizationDeprecated
autoupdate - Variable in class org.zaproxy.clientapi.core.ClientApi
Autoupdate - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Autoupdate(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Autoupdate
AutoupdateDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
AutoupdateDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.AutoupdateDeprecated

B

Break - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Break(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Break
BreakDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
BreakDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.BreakDeprecated
breakTextMessage() - Method in class org.zaproxy.clientapi.gen.Websocket: Returns a text representation of an intercepted websockets message
brk - Variable in class org.zaproxy.clientapi.core.ClientApi
brk(String, String, String) - Method in class org.zaproxy.clientapi.gen.Break: Controls the global break functionality.
brk(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.BreakDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).

C

callApi(String, String, String, Map<String, String>) - Method in class org.zaproxy.clientapi.core.ClientApi
callApiOther(String, String, String, Map<String, String>) - Method in class org.zaproxy.clientapi.core.ClientApi
channels() - Method in class org.zaproxy.clientapi.gen.Websocket: Returns all of the registered web socket channels
checkAlerts(List<Alert>, List<Alert>) - Method in class org.zaproxy.clientapi.core.ClientApi
checkAlerts(List<Alert>, List<Alert>, File) - Method in class org.zaproxy.clientapi.core.ClientApi
childNodes(String) - Method in class org.zaproxy.clientapi.gen.Core: Gets the child nodes underneath the specified URL in the Sites tree
clearExcludedFromProxy() - Method in class org.zaproxy.clientapi.gen.Core: Clears the regexes of URLs excluded from the local proxies.
clearExcludedFromProxy(String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
clearExcludedFromScan() - Method in class org.zaproxy.clientapi.gen.Ascan: Clears the regexes of URLs excluded from the active scans.
clearExcludedFromScan(String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
clearExcludedFromScan(String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
clearExcludedFromScan() - Method in class org.zaproxy.clientapi.gen.Spider: Clears the regexes of URLs excluded from the spider scans.
clearGlobalVar(String) - Method in class org.zaproxy.clientapi.gen.Script: Clears the global variable with the given key.
clearGlobalVars() - Method in class org.zaproxy.clientapi.gen.Script: Clears the global variables.
clearScriptVar(String, String) - Method in class org.zaproxy.clientapi.gen.Script: Clears the variable with the given key of the given script.
clearScriptVars(String) - Method in class org.zaproxy.clientapi.gen.Script: Clears the variables of the given script.
clearStats(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.StatsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
clearStats(String) - Method in class org.zaproxy.clientapi.gen.Stats: Clears all of the statistics
ClientApi - Class in org.zaproxy.clientapi.core
ClientApi(String, int) - Constructor for class org.zaproxy.clientapi.core.ClientApi
ClientApi(String, int, String) - Constructor for class org.zaproxy.clientapi.core.ClientApi: Constructs a ClientApi with the given ZAP address/port and with the given API key, to be sent with all API requests.
ClientApi(String, int, boolean) - Constructor for class org.zaproxy.clientapi.core.ClientApi
ClientApi(String, int, String, boolean) - Constructor for class org.zaproxy.clientapi.core.ClientApi: Constructs a ClientApi with the given ZAP address/port and with the given API key, to be sent with all API requests.
ClientApiException - Exception in org.zaproxy.clientapi.core
ClientApiException(Exception) - Constructor for exception org.zaproxy.clientapi.core.ClientApiException
ClientApiException(String) - Constructor for exception org.zaproxy.clientapi.core.ClientApiException
ClientApiException(String, Exception) - Constructor for exception org.zaproxy.clientapi.core.ClientApiException
ClientApiException(String, String, String) - Constructor for exception org.zaproxy.clientapi.core.ClientApiException
ClientApiMain - Class in org.zaproxy.clientapi.core
ClientApiMain(String[]) - Constructor for class org.zaproxy.clientapi.core.ClientApiMain
cont() - Method in class org.zaproxy.clientapi.gen.Break: Submits the currently intercepted message and unsets the global request/response break points
context - Variable in class org.zaproxy.clientapi.core.ClientApi
Context - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Context(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Context
context(String) - Method in class org.zaproxy.clientapi.gen.Context: List the information about the named context
ContextDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
ContextDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated
contextList() - Method in class org.zaproxy.clientapi.gen.Context: List context names of current session
core - Variable in class org.zaproxy.clientapi.core.ClientApi
Core - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Core(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Core
CoreDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
CoreDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated
createEmptySession(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.HttpSessionsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
createEmptySession(String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Creates an empty session for the given site.
currentRule() - Method in class org.zaproxy.clientapi.gen.Pscan: Show information about the passive scan rule currently being run (if any).

D

defaultSessionTokens() - Method in class org.zaproxy.clientapi.gen.HttpSessions: Gets the default session tokens.
deleteAlert(String) - Method in class org.zaproxy.clientapi.gen.Alert: Deletes the alert with the given ID.
deleteAlert(String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoint with the same name in the 'alert' component instead.
deleteAllAlerts() - Method in class org.zaproxy.clientapi.gen.Alert: Deletes all alerts of the current session.
deleteAllAlerts() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoint with the same name in the 'alert' component instead.
deleteAllAlerts(String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
deleteSiteNode(String, String, String) - Method in class org.zaproxy.clientapi.gen.Core: Deletes the site node found in the Sites Tree on the basis of the URL, HTTP method, and post data (if applicable and specified).
deleteSiteNode(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
disable(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ScriptDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
disable(String) - Method in class org.zaproxy.clientapi.gen.Script: Disables the script with the given name
disableAllDomainsAlwaysInScope() - Method in class org.zaproxy.clientapi.gen.Spider: Disables all domains that are always in scope.
disableAllProxyChainExcludedDomains() - Method in class org.zaproxy.clientapi.gen.Core: Disables all domains excluded from the outgoing proxy.
disableAllScanners(String) - Method in class org.zaproxy.clientapi.gen.Ascan: Disables all scanners of the scan policy with the given name, or the default if none given.
disableAllScanners(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
disableAllScanners(String) - Method in class org.zaproxy.clientapi.gen.deprecated.PscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
disableAllScanners() - Method in class org.zaproxy.clientapi.gen.Pscan: Disables all passive scanners
disableClientCertificate() - Method in class org.zaproxy.clientapi.gen.Core: Disables the option for use of client certificates.
disableScanners(String, String) - Method in class org.zaproxy.clientapi.gen.Ascan: Disables the scanners with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.
disableScanners(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
disableScanners(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.PscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
disableScanners(String) - Method in class org.zaproxy.clientapi.gen.Pscan: Disables all passive scanners with the given IDs (comma separated list of IDs)
domainsAlwaysInScope() - Method in class org.zaproxy.clientapi.gen.Spider: Gets all the domains that are always in scope.
downloadLatestRelease() - Method in class org.zaproxy.clientapi.gen.Autoupdate: Downloads the latest release, if any
downloadLatestRelease(String) - Method in class org.zaproxy.clientapi.gen.deprecated.AutoupdateDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
drop() - Method in class org.zaproxy.clientapi.gen.Break: Drops the currently intercepted message

E

enable(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ScriptDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
enable(String) - Method in class org.zaproxy.clientapi.gen.Script: Enables the script with the given name
enableAllDomainsAlwaysInScope() - Method in class org.zaproxy.clientapi.gen.Spider: Enables all domains that are always in scope.
enableAllProxyChainExcludedDomains() - Method in class org.zaproxy.clientapi.gen.Core: Enables all domains excluded from the outgoing proxy.
enableAllScanners(String) - Method in class org.zaproxy.clientapi.gen.Ascan: Enables all scanners of the scan policy with the given name, or the default if none given.
enableAllScanners(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
enableAllScanners(String) - Method in class org.zaproxy.clientapi.gen.deprecated.PscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
enableAllScanners() - Method in class org.zaproxy.clientapi.gen.Pscan: Enables all passive scanners
enablePKCS12ClientCertificate(String, String, String) - Method in class org.zaproxy.clientapi.gen.Core: Enables use of a PKCS12 client certificate for the certificate with the given file system path, password, and optional index.
enableScanners(String, String) - Method in class org.zaproxy.clientapi.gen.Ascan: Enables the scanners with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.
enableScanners(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
enableScanners(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.PscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
enableScanners(String) - Method in class org.zaproxy.clientapi.gen.Pscan: Enables all passive scanners with the given IDs (comma separated list of IDs)
equals(Object) - Method in class org.zaproxy.clientapi.core.Alert
excludeAllContextTechnologies(String) - Method in class org.zaproxy.clientapi.gen.Context: Excludes all built in technologies from a context
excludeAllContextTechnologies(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
excludeContextTechnologies(String, String) - Method in class org.zaproxy.clientapi.gen.Context: Excludes technologies with the given names, separated by a comma, from a context
excludeContextTechnologies(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
excludedFromProxy() - Method in class org.zaproxy.clientapi.gen.Core: Gets the regular expressions, applied to URLs, to exclude from the local proxies.
excludedFromScan() - Method in class org.zaproxy.clientapi.gen.Ascan: Gets the regexes of URLs excluded from the active scans.
excludedFromScan() - Method in class org.zaproxy.clientapi.gen.Spider: Gets the regexes of URLs excluded from the spider scans.
excludedParams() - Method in class org.zaproxy.clientapi.gen.Ascan: Gets all the parameters that are excluded.
excludedParamTypes() - Method in class org.zaproxy.clientapi.gen.Ascan: Gets all the types of excluded parameters.
excludedTechnologyList(String) - Method in class org.zaproxy.clientapi.gen.Context: Lists the names of all technologies excluded from a context
excludeFromContext(String, String) - Method in class org.zaproxy.clientapi.gen.Context: Add exclude regex to context
excludeFromContext(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
excludeFromProxy(String) - Method in class org.zaproxy.clientapi.gen.Core: Adds a regex of URLs that should be excluded from the local proxies.
excludeFromProxy(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
excludeFromScan(String) - Method in class org.zaproxy.clientapi.gen.Ascan: Adds a regex of URLs that should be excluded from the active scans.
excludeFromScan(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
excludeFromScan(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
excludeFromScan(String) - Method in class org.zaproxy.clientapi.gen.Spider: Adds a regex of URLs that should be excluded from the spider scans.
excludeRegexs(String) - Method in class org.zaproxy.clientapi.gen.Context: List excluded regexs for context
exportContext(String, String) - Method in class org.zaproxy.clientapi.gen.Context: Exports the context with the given name to a file.
exportContext(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).

F

FAIL - Static variable in class org.zaproxy.clientapi.core.ApiResponseElement
forcedUser - Variable in class org.zaproxy.clientapi.core.ClientApi
ForcedUser - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
ForcedUser(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.ForcedUser
ForcedUserDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
ForcedUserDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.ForcedUserDeprecated
fullResults() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
fullResults(String) - Method in class org.zaproxy.clientapi.gen.Spider
fx_pnhxpi(String) - Method in class org.zaproxy.clientapi.gen.deprecated.PnhDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
fx_pnhxpi() - Method in class org.zaproxy.clientapi.gen.Pnh: This component is optional and therefore the API will only work if it is installed

G

generateRootCA() - Method in class org.zaproxy.clientapi.gen.Core: Generates a new Root CA certificate for the local proxies.
generateRootCA(String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
genForm(String) - Method in class org.zaproxy.clientapi.gen.Acsrf: Generate a form for testing lack of anti-CSRF tokens - typically invoked via ZAP
genForm(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AcsrfDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
getAlert() - Method in class org.zaproxy.clientapi.core.Alert: Deprecated.
(1.1.0) Use Alert.getName() instead.
getAlerts(String, int, int) - Method in class org.zaproxy.clientapi.core.ClientApi
getAlertsFromFile(File, String) - Static method in class org.zaproxy.clientapi.core.AlertsFile
getAttack() - Method in class org.zaproxy.clientapi.core.Alert
getAttribute(String) - Method in class org.zaproxy.clientapi.core.ApiResponseSet: Deprecated.
(1.1.0) Use ApiResponseSet.getStringValue(String) or ApiResponseSet.getValue(String) instead.
getAttributes() - Method in class org.zaproxy.clientapi.core.ApiResponseSet: Deprecated.
(1.1.0) Unused, there's no replacement.
getAuthenticationCredentials(String, String) - Method in class org.zaproxy.clientapi.gen.Users: Gets the authentication credentials of the user with given ID that belongs to the context with the given ID.
getAuthenticationCredentialsConfigParams(String) - Method in class org.zaproxy.clientapi.gen.Users: Gets the configuration parameters for the credentials of the context with the given ID.
getAuthenticationMethod(String) - Method in class org.zaproxy.clientapi.gen.Authentication: Gets the name of the authentication method for the context with the given ID.
getAuthenticationMethodConfigParams(String) - Method in class org.zaproxy.clientapi.gen.Authentication: Gets the configuration parameters for the authentication method with the given name.
getAuthorizationDetectionMethod(String) - Method in class org.zaproxy.clientapi.gen.Authorization: Obtains all the configuration of the authorization detection method that is currently set for a context.
getCode() - Method in exception org.zaproxy.clientapi.core.ClientApiException
getConfidence() - Method in class org.zaproxy.clientapi.core.Alert
getCweId() - Method in class org.zaproxy.clientapi.core.Alert
getDescription() - Method in class org.zaproxy.clientapi.core.Alert
getDetail() - Method in exception org.zaproxy.clientapi.core.ClientApiException
getEvidence() - Method in class org.zaproxy.clientapi.core.Alert
getForcedUser(String) - Method in class org.zaproxy.clientapi.gen.ForcedUser: Gets the user (ID) set as 'forced user' for the given context (ID)
getId() - Method in class org.zaproxy.clientapi.core.Alert: Gets the ID of the alert.
getItems() - Method in class org.zaproxy.clientapi.core.ApiResponseList
getItemsClass() - Method in class org.zaproxy.clientapi.core.ApiResponseList
getKeys() - Method in class org.zaproxy.clientapi.core.ApiResponseSet: Gets the keys of the values.
getLoggedInIndicator(String) - Method in class org.zaproxy.clientapi.gen.Authentication: Gets the logged in indicator for the context with the given ID.
getLoggedOutIndicator(String) - Method in class org.zaproxy.clientapi.gen.Authentication: Gets the logged out indicator for the context with the given ID.
getMessageId() - Method in class org.zaproxy.clientapi.core.Alert: Gets the ID of the HTTP message of the alert.
getName() - Method in class org.zaproxy.clientapi.core.Alert: Gets the name of the alert.
getName() - Method in class org.zaproxy.clientapi.core.ApiResponse
getOther() - Method in class org.zaproxy.clientapi.core.Alert
getParam() - Method in class org.zaproxy.clientapi.core.Alert
getPluginId() - Method in class org.zaproxy.clientapi.core.Alert: Gets the ID of the plugin/scanner that raised the alert.
getReference() - Method in class org.zaproxy.clientapi.core.Alert
getReliability() - Method in class org.zaproxy.clientapi.core.Alert: Deprecated.
Alert.getConfidence() Use of reliability has been deprecated in favour of using confidence
getResponse(Node) - Static method in class org.zaproxy.clientapi.core.ApiResponseFactory
getRisk() - Method in class org.zaproxy.clientapi.core.Alert
getSessionManagementMethod(String) - Method in class org.zaproxy.clientapi.gen.SessionManagement: Gets the name of the session management method for the context with the given ID.
getSessionManagementMethodConfigParams(String) - Method in class org.zaproxy.clientapi.gen.SessionManagement: Gets the configuration parameters for the session management method with the given name.
getSolution() - Method in class org.zaproxy.clientapi.core.Alert
getStringValue(String) - Method in class org.zaproxy.clientapi.core.ApiResponseSet: Gets the value for the given key as String.
getSupportedAuthenticationMethods() - Method in class org.zaproxy.clientapi.gen.Authentication: Gets the name of the authentication methods.
getSupportedSessionManagementMethods() - Method in class org.zaproxy.clientapi.gen.SessionManagement: Gets the name of the session management methods.
getUrl() - Method in class org.zaproxy.clientapi.core.Alert
getUserById(String, String) - Method in class org.zaproxy.clientapi.gen.Users: Gets the data of the user with the given ID that belongs to the context with the given ID.
getValue() - Method in class org.zaproxy.clientapi.core.ApiResponseElement
getValue(String) - Method in class org.zaproxy.clientapi.core.ApiResponseSet: Gets the value for the given key.
getValues() - Method in class org.zaproxy.clientapi.core.ApiResponseSet: Gets the values.
getValuesMap() - Method in class org.zaproxy.clientapi.core.ApiResponseSet: Gets a Map with the keys and values.
getWascId() - Method in class org.zaproxy.clientapi.core.Alert
globalVar(String) - Method in class org.zaproxy.clientapi.gen.Script: Gets the value of the global variable with the given key.
globalVars() - Method in class org.zaproxy.clientapi.gen.Script: Gets all the global variables (key/value pairs).

H

harByHeaderRegex(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SearchDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
harByHeaderRegex(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Search: Returns the HTTP messages, in HAR format, that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
harByRequestRegex(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SearchDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
harByRequestRegex(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Search: Returns the HTTP messages, in HAR format, that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
harByResponseRegex(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SearchDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
harByResponseRegex(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Search: Returns the HTTP messages, in HAR format, that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
harByUrlRegex(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SearchDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
harByUrlRegex(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Search: Returns the HTTP messages, in HAR format, that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
hashCode() - Method in class org.zaproxy.clientapi.core.Alert
homeDirectory() - Method in class org.zaproxy.clientapi.gen.Core
hosts() - Method in class org.zaproxy.clientapi.gen.Core: Gets the name of the hosts accessed through/by ZAP
htmlreport() - Method in class org.zaproxy.clientapi.gen.Core: Generates a report in HTML format
htmlreport(String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
httpMessage() - Method in class org.zaproxy.clientapi.gen.Break: Returns the HTTP message currently intercepted (if any)
httpSessions - Variable in class org.zaproxy.clientapi.core.ClientApi
HttpSessions - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
HttpSessions(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.HttpSessions
HttpSessionsDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
HttpSessionsDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.HttpSessionsDeprecated

I

importContext(String) - Method in class org.zaproxy.clientapi.gen.Context: Imports a context from a file.
importContext(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
importFile(String) - Method in class org.zaproxy.clientapi.gen.Openapi: Import an Open API definition from a local file.
importFile(String) - Method in class org.zaproxy.clientapi.gen.Soap: Import a WSDL definition from local file.
ImportLogFiles - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
ImportLogFiles(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.ImportLogFiles
ImportLogFilesDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
ImportLogFilesDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.ImportLogFilesDeprecated
ImportModSecurityLogFromFile(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ImportLogFilesDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
ImportModSecurityLogFromFile(String) - Method in class org.zaproxy.clientapi.gen.ImportLogFiles: This component is optional and therefore the API will only work if it is installed
importScanPolicy(String) - Method in class org.zaproxy.clientapi.gen.Ascan: Imports a Scan Policy using the given file system path.
importUrl(String, String) - Method in class org.zaproxy.clientapi.gen.Openapi: Import an Open API definition from a URL, hostOverride allows the host to be replaced
importUrl(String) - Method in class org.zaproxy.clientapi.gen.Soap: Import a WSDL definition from a URL.
importurls - Variable in class org.zaproxy.clientapi.core.ClientApi
Importurls - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Importurls(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Importurls
importurls(String) - Method in class org.zaproxy.clientapi.gen.Importurls: Imports URLs (one per line) from the file with the given file system path.
ImportZAPHttpRequestResponsePair(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ImportLogFilesDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
ImportZAPHttpRequestResponsePair(String, String) - Method in class org.zaproxy.clientapi.gen.ImportLogFiles: This component is optional and therefore the API will only work if it is installed
ImportZAPLogFromFile(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ImportLogFilesDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
ImportZAPLogFromFile(String) - Method in class org.zaproxy.clientapi.gen.ImportLogFiles: This component is optional and therefore the API will only work if it is installed
includeAllContextTechnologies(String) - Method in class org.zaproxy.clientapi.gen.Context: Includes all built in technologies in to a context
includeAllContextTechnologies(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
includeContextTechnologies(String, String) - Method in class org.zaproxy.clientapi.gen.Context: Includes technologies with the given names, separated by a comma, to a context
includeContextTechnologies(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
includedTechnologyList(String) - Method in class org.zaproxy.clientapi.gen.Context: Lists the names of all technologies included in a context
includeInContext(String, String) - Method in class org.zaproxy.clientapi.gen.Context: Add include regex to context
includeInContext(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
includeOneMatchingNodeInContext(String, String, String) - Method in class org.zaproxy.clientapi.core.ClientApi: Deprecated.
(1.1.0) Use ClientApi.includeOneMatchingNodeInContext(String, String) instead.
includeOneMatchingNodeInContext(String, String) - Method in class org.zaproxy.clientapi.core.ClientApi: Includes just one of the nodes that match the given regular expression in the context with the given name.
includeRegexs(String) - Method in class org.zaproxy.clientapi.gen.Context: List included regexs for context
installAddon(String) - Method in class org.zaproxy.clientapi.gen.Autoupdate: Installs or updates the specified add-on, returning when complete (ie not asynchronously)
installedAddons() - Method in class org.zaproxy.clientapi.gen.Autoupdate: Return a list of all of the installed add-ons
installLocalAddon(String) - Method in class org.zaproxy.clientapi.gen.Autoupdate
isBreakAll() - Method in class org.zaproxy.clientapi.gen.Break: Returns True if ZAP will break on both requests and responses
isBreakRequest() - Method in class org.zaproxy.clientapi.gen.Break: Returns True if ZAP will break on requests
isBreakResponse() - Method in class org.zaproxy.clientapi.gen.Break: Returns True if ZAP will break on responses
isForcedUserModeEnabled() - Method in class org.zaproxy.clientapi.gen.ForcedUser: Returns 'true' if 'forced user' mode is enabled, 'false' otherwise
isLatestVersion() - Method in class org.zaproxy.clientapi.gen.Autoupdate: Returns 'true' if ZAP is on the latest version

J

jsonreport() - Method in class org.zaproxy.clientapi.gen.Core: Generates a report in JSON format

L

latestVersionNumber() - Method in class org.zaproxy.clientapi.gen.Autoupdate: Returns the latest version number
listEngines() - Method in class org.zaproxy.clientapi.gen.Script: Lists the script engines available
listScripts() - Method in class org.zaproxy.clientapi.gen.Script: Lists the scripts available, with its engine, name, description, type and error state.
listTypes() - Method in class org.zaproxy.clientapi.gen.Script: Lists the script types available.
load(String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ScriptDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
load(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ScriptDeprecated: Loads a script into ZAP from the given local file, with the given name, type and engine, optionally with a description
load(String, String, String, String, String, Charset) - Method in class org.zaproxy.clientapi.gen.Script: Loads a script into ZAP from the given local file, with the given name, type and engine, optionally with a description, and a charset name to read the script (the charset name is required if the script is not in UTF-8, for example, in ISO-8859-1).
loadSession(String) - Method in class org.zaproxy.clientapi.gen.Core: Loads the session with the given name.
loadSession(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
localAddons() - Method in class org.zaproxy.clientapi.gen.Autoupdate: Returns a list with all local add-ons, installed or not.
logImportFiles - Variable in class org.zaproxy.clientapi.core.ClientApi

M

main(String[]) - Static method in class org.zaproxy.clientapi.core.ClientApiMain
manifest(String) - Method in class org.zaproxy.clientapi.gen.deprecated.PnhDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
manifest() - Method in class org.zaproxy.clientapi.gen.Pnh: This component is optional and therefore the API will only work if it is installed
marketplaceAddons() - Method in class org.zaproxy.clientapi.gen.Autoupdate: Return a list of all of the add-ons on the ZAP Marketplace (this information is read once and then cached)
matches(Alert) - Method in class org.zaproxy.clientapi.core.Alert
maxAlertsPerRule() - Method in class org.zaproxy.clientapi.gen.Pscan: Gets the maximum number of alerts a passive scan rule should raise.
mdreport() - Method in class org.zaproxy.clientapi.gen.Core: Generates a report in Markdown format
message(String) - Method in class org.zaproxy.clientapi.gen.Core: Gets the HTTP message with the given ID.
message(String, String) - Method in class org.zaproxy.clientapi.gen.Websocket: Returns full details of the message specified by the channelId and messageId
messageHar(String) - Method in class org.zaproxy.clientapi.gen.Core: Gets the message with the given ID in HAR format
messageHar(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
messages(String, String, String) - Method in class org.zaproxy.clientapi.gen.Core: Gets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages
messages(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Websocket: Returns a list of all of the messages that meet the given criteria (all optional), where channelId is a channel identifier, start is the offset to start returning messages from (starting from 0), count is the number of messages to return (default no limit) and payloadPreviewLength is the maximum number bytes to return for the payload contents
messagesByHeaderRegex(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Search: Returns the HTTP messages that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
messagesById(String) - Method in class org.zaproxy.clientapi.gen.Core: Gets the HTTP messages with the given IDs.
messagesByRequestRegex(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Search: Returns the HTTP messages that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
messagesByResponseRegex(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Search: Returns the HTTP messages that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
messagesByUrlRegex(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Search: Returns the HTTP messages that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
messagesHar(String, String, String) - Method in class org.zaproxy.clientapi.gen.Core: Gets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages
messagesHar(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
messagesHarById(String) - Method in class org.zaproxy.clientapi.gen.Core: Gets the HTTP messages with the given IDs, in HAR format.
messagesIds(String) - Method in class org.zaproxy.clientapi.gen.Ascan: Gets the IDs of the messages sent during the scan with the given ID.
mode() - Method in class org.zaproxy.clientapi.gen.Core: Gets the mode
modifyDomainAlwaysInScope(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Spider: Modifies a domain that's always in scope.
modifyExcludedParam(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan: Modifies a parameter excluded from the scan.
modifyProxyChainExcludedDomain(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Core: Modifies a domain excluded from the outgoing proxy.
monitor(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.PnhDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
monitor(String, String) - Method in class org.zaproxy.clientapi.gen.Pnh: This component is optional and therefore the API will only work if it is installed

N

newAddons() - Method in class org.zaproxy.clientapi.gen.Autoupdate: Return a list of any add-ons that have been added to the Marketplace since the last check for updates
newContext(String) - Method in class org.zaproxy.clientapi.gen.Context: Creates a new context with the given name in the current session
newContext(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
newSession(String, String) - Method in class org.zaproxy.clientapi.gen.Core: Creates a new session, optionally overwriting existing files.
newSession(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
newUser(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.UsersDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
newUser(String, String) - Method in class org.zaproxy.clientapi.gen.Users: Creates a new user with the given name for the context with the given ID.
numberOfAlerts(String, String) - Method in class org.zaproxy.clientapi.gen.Alert: Gets the number of alerts, optionally filtering by URL or riskId
numberOfAlerts(String, String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoint with the same name in the 'alert' component instead.
numberOfAlerts(String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Gets the number of alerts, optionally filtering by URL
numberOfMessages(String) - Method in class org.zaproxy.clientapi.gen.Core: Gets the number of messages, optionally filtering by URL
numberOfResults() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed

O

OK - Static variable in class org.zaproxy.clientapi.core.ApiResponseElement
openapi - Variable in class org.zaproxy.clientapi.core.ClientApi
Openapi - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Openapi(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Openapi
optionAcceptCookies() - Method in class org.zaproxy.clientapi.gen.Spider: Gets whether or not a spider process should accept cookies while spidering.
optionAddonDirectories() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionAddQueryParam() - Method in class org.zaproxy.clientapi.gen.Ascan: Tells whether or not the active scanner should add a query parameter to GET request that don't have parameters to start with.
optionAlertOverridesFilePath() - Method in class org.zaproxy.clientapi.gen.Core: Gets the path to the file with alert overrides.
optionAllowAttackOnStart() - Method in class org.zaproxy.clientapi.gen.Ascan
optionAttackPolicy() - Method in class org.zaproxy.clientapi.gen.Ascan
optionBrowserId() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
optionCheckAddonUpdates() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionCheckOnStart() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionChromeDriverPath() - Method in class org.zaproxy.clientapi.gen.Selenium: Returns the current path to ChromeDriver
optionClickDefaultElems() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
optionClickElemsOnce() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
optionDayLastChecked() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionDayLastInstallWarned() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionDayLastUpdateWarned() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionDefaultPolicy() - Method in class org.zaproxy.clientapi.gen.Ascan
optionDefaultUserAgent() - Method in class org.zaproxy.clientapi.gen.Core: Gets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy).
optionDelayInMs() - Method in class org.zaproxy.clientapi.gen.Ascan
optionDnsTtlSuccessfulQueries() - Method in class org.zaproxy.clientapi.gen.Core: Gets the TTL (in seconds) of successful DNS queries.
optionDomainsAlwaysInScope() - Method in class org.zaproxy.clientapi.gen.Spider: Deprecated.
optionDomainsAlwaysInScopeEnabled() - Method in class org.zaproxy.clientapi.gen.Spider: Deprecated.
optionDownloadDirectory() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionDownloadNewRelease() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionEventWait() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
optionExcludedParamList() - Method in class org.zaproxy.clientapi.gen.Ascan: Deprecated.
optionFirefoxBinaryPath() - Method in class org.zaproxy.clientapi.gen.Selenium: Returns the current path to Firefox binary
optionFirefoxDriverPath() - Method in class org.zaproxy.clientapi.gen.Selenium: Returns the current path to Firefox driver (geckodriver)
optionHandleAntiCSRFTokens() - Method in class org.zaproxy.clientapi.gen.Ascan
optionHandleODataParametersVisited() - Method in class org.zaproxy.clientapi.gen.Spider
optionHandleParameters() - Method in class org.zaproxy.clientapi.gen.Spider
optionHostPerScan() - Method in class org.zaproxy.clientapi.gen.Ascan
optionHttpState() - Method in class org.zaproxy.clientapi.gen.Core
optionHttpStateEnabled() - Method in class org.zaproxy.clientapi.gen.Core
optionIeDriverPath() - Method in class org.zaproxy.clientapi.gen.Selenium: Deprecated.
optionInjectPluginIdInHeader() - Method in class org.zaproxy.clientapi.gen.Ascan: Tells whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scanner that's sending the requests.
optionInMemoryEnabled() - Method in class org.zaproxy.clientapi.gen.Stats: Returns 'true' if in memory statistics are enabled, otherwise returns 'false'
optionInstallAddonUpdates() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionInstallScannerRules() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionMaxChartTimeInMins() - Method in class org.zaproxy.clientapi.gen.Ascan
optionMaxChildren() - Method in class org.zaproxy.clientapi.gen.Spider: Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
optionMaxCrawlDepth() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
optionMaxCrawlStates() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
optionMaxDepth() - Method in class org.zaproxy.clientapi.gen.Spider: Gets the maximum depth the spider can crawl, 0 if unlimited.
optionMaxDuration() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
optionMaxDuration() - Method in class org.zaproxy.clientapi.gen.Spider
optionMaximumAlertInstances() - Method in class org.zaproxy.clientapi.gen.Core: Gets the maximum number of alert instances to include in a report.
optionMaxParseSizeBytes() - Method in class org.zaproxy.clientapi.gen.Spider: Gets the maximum size, in bytes, that a response might have to be parsed.
optionMaxResultsToList() - Method in class org.zaproxy.clientapi.gen.Ascan
optionMaxRuleDurationInMins() - Method in class org.zaproxy.clientapi.gen.Ascan
optionMaxScanDurationInMins() - Method in class org.zaproxy.clientapi.gen.Ascan
optionMaxScansInUI() - Method in class org.zaproxy.clientapi.gen.Ascan
optionMaxScansInUI() - Method in class org.zaproxy.clientapi.gen.Spider
optionMergeRelatedAlerts() - Method in class org.zaproxy.clientapi.gen.Core: Gets whether or not related alerts will be merged in any reports generated.
optionNumberOfBrowsers() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
optionParseComments() - Method in class org.zaproxy.clientapi.gen.Spider
optionParseGit() - Method in class org.zaproxy.clientapi.gen.Spider
optionParseRobotsTxt() - Method in class org.zaproxy.clientapi.gen.Spider
optionParseSitemapXml() - Method in class org.zaproxy.clientapi.gen.Spider
optionParseSVNEntries() - Method in class org.zaproxy.clientapi.gen.Spider
optionPhantomJsBinaryPath() - Method in class org.zaproxy.clientapi.gen.Selenium: Returns the current path to PhantomJS binary
optionPostForm() - Method in class org.zaproxy.clientapi.gen.Spider
optionProcessForm() - Method in class org.zaproxy.clientapi.gen.Spider
optionPromptInAttackMode() - Method in class org.zaproxy.clientapi.gen.Ascan
optionPromptToClearFinishedScans() - Method in class org.zaproxy.clientapi.gen.Ascan
optionProxyChainName() - Method in class org.zaproxy.clientapi.gen.Core
optionProxyChainPassword() - Method in class org.zaproxy.clientapi.gen.Core
optionProxyChainPort() - Method in class org.zaproxy.clientapi.gen.Core
optionProxyChainPrompt() - Method in class org.zaproxy.clientapi.gen.Core
optionProxyChainRealm() - Method in class org.zaproxy.clientapi.gen.Core
optionProxyChainSkipName() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
optionProxyChainUserName() - Method in class org.zaproxy.clientapi.gen.Core
optionProxyExcludedDomains() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
optionProxyExcludedDomainsEnabled() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
optionRandomInputs() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
optionReloadWait() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
optionReportAlphaAddons() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionReportBetaAddons() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionReportReleaseAddons() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionRequestWaitTime() - Method in class org.zaproxy.clientapi.gen.Spider
optionRescanInAttackMode() - Method in class org.zaproxy.clientapi.gen.Ascan
optionScanHeadersAllRequests() - Method in class org.zaproxy.clientapi.gen.Ascan: Tells whether or not the HTTP Headers of all requests should be scanned.
optionScope() - Method in class org.zaproxy.clientapi.gen.Spider: Deprecated.
optionScopeText() - Method in class org.zaproxy.clientapi.gen.Spider: Deprecated.
optionSendRefererHeader() - Method in class org.zaproxy.clientapi.gen.Spider: Gets whether or not the 'Referer' header should be sent while spidering.
optionShowAdvancedDialog() - Method in class org.zaproxy.clientapi.gen.Ascan
optionShowAdvancedDialog() - Method in class org.zaproxy.clientapi.gen.Spider
optionSingleCookieRequestHeader() - Method in class org.zaproxy.clientapi.gen.Core
optionSkipURLString() - Method in class org.zaproxy.clientapi.gen.Spider
optionStatsdEnabled() - Method in class org.zaproxy.clientapi.gen.Stats: Returns 'true' if a Statsd server has been correctly configured, otherwise returns 'false'
optionStatsdHost() - Method in class org.zaproxy.clientapi.gen.Stats: Gets the Statsd service hostname
optionStatsdPort() - Method in class org.zaproxy.clientapi.gen.Stats: Gets the Statsd service port
optionStatsdPrefix() - Method in class org.zaproxy.clientapi.gen.Stats: Gets the prefix to be applied to all stats sent to the configured Statsd service
optionTargetParamsEnabledRPC() - Method in class org.zaproxy.clientapi.gen.Ascan
optionTargetParamsInjectable() - Method in class org.zaproxy.clientapi.gen.Ascan
optionThreadCount() - Method in class org.zaproxy.clientapi.gen.Spider
optionThreadPerHost() - Method in class org.zaproxy.clientapi.gen.Ascan
optionTimeoutInSecs() - Method in class org.zaproxy.clientapi.gen.Core: Gets the connection time out, in seconds.
optionTokensNames() - Method in class org.zaproxy.clientapi.gen.Acsrf: Lists the names of all anti-CSRF tokens
optionUseProxyChain() - Method in class org.zaproxy.clientapi.gen.Core
optionUseProxyChainAuth() - Method in class org.zaproxy.clientapi.gen.Core
optionUserAgent() - Method in class org.zaproxy.clientapi.gen.Spider
oracle(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.PnhDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
oracle(String) - Method in class org.zaproxy.clientapi.gen.Pnh: This component is optional and therefore the API will only work if it is installed
org.zaproxy.clientapi.core - package org.zaproxy.clientapi.core
org.zaproxy.clientapi.gen - package org.zaproxy.clientapi.gen
org.zaproxy.clientapi.gen.deprecated - package org.zaproxy.clientapi.gen.deprecated
OtherPostModSecurityAuditEvent(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ImportLogFilesDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
OtherPostModSecurityAuditEvent(String) - Method in class org.zaproxy.clientapi.gen.ImportLogFiles: This component is optional and therefore the API will only work if it is installed

P

params - Variable in class org.zaproxy.clientapi.core.ClientApi
Params - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Params(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Params
params(String) - Method in class org.zaproxy.clientapi.gen.Params: Shows the parameters for the specified site, or for all sites if the site is not specified
pause(String) - Method in class org.zaproxy.clientapi.gen.Ascan
pause(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
pause(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
pause(String) - Method in class org.zaproxy.clientapi.gen.Spider
pauseAllScans() - Method in class org.zaproxy.clientapi.gen.Ascan
pauseAllScans(String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
pauseAllScans(String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
pauseAllScans() - Method in class org.zaproxy.clientapi.gen.Spider
pnh - Variable in class org.zaproxy.clientapi.core.ClientApi
pnh(String) - Method in class org.zaproxy.clientapi.gen.deprecated.PnhDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
Pnh - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Pnh(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Pnh
pnh() - Method in class org.zaproxy.clientapi.gen.Pnh: This component is optional and therefore the API will only work if it is installed
PnhDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
PnhDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.PnhDeprecated
policies(String, String) - Method in class org.zaproxy.clientapi.gen.Ascan
PostModSecurityAuditEvent(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ImportLogFilesDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
PostModSecurityAuditEvent(String) - Method in class org.zaproxy.clientapi.gen.ImportLogFiles: This component is optional and therefore the API will only work if it is installed
proxyChainExcludedDomains() - Method in class org.zaproxy.clientapi.gen.Core: Gets all the domains that are excluded from the outgoing proxy.
proxypac() - Method in class org.zaproxy.clientapi.gen.Core
proxypac(String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
pscan - Variable in class org.zaproxy.clientapi.core.ClientApi
Pscan - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Pscan(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Pscan
PscanDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
PscanDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.PscanDeprecated

R

recordsToScan() - Method in class org.zaproxy.clientapi.gen.Pscan: The number of records the passive scanner still has to scan
remove(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ScriptDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
remove(String) - Method in class org.zaproxy.clientapi.gen.Script: Removes the script with the given name
removeAlertFilter(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.AlertFilter: Removes an alert filter from the context with the given ID.
removeAllScans() - Method in class org.zaproxy.clientapi.gen.Ascan
removeAllScans(String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
removeAllScans(String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
removeAllScans() - Method in class org.zaproxy.clientapi.gen.Spider
removeContext(String) - Method in class org.zaproxy.clientapi.gen.Context: Removes a context in the current session
removeContext(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
removeDefaultSessionToken(String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Removes the default session token with the given name.
removeDomainAlwaysInScope(String) - Method in class org.zaproxy.clientapi.gen.Spider: Removes a domain that's always in scope, with the given index.
removeExcludedParam(String) - Method in class org.zaproxy.clientapi.gen.Ascan: Removes a parameter excluded from the scan, with the given index.
removeHttpBreakpoint(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Break: Removes the specified break point
removeHttpBreakpoint(String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.BreakDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
removeOptionToken(String) - Method in class org.zaproxy.clientapi.gen.Acsrf: Removes the anti-CSRF token with the given name
removeOptionToken(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AcsrfDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
removeProxyChainExcludedDomain(String) - Method in class org.zaproxy.clientapi.gen.Core: Removes a domain excluded from the outgoing proxy, with the given index.
removeRule(String) - Method in class org.zaproxy.clientapi.gen.Replacer: Removes the rule with the given description
removeScan(String) - Method in class org.zaproxy.clientapi.gen.Ascan
removeScan(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
removeScan(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
removeScan(String) - Method in class org.zaproxy.clientapi.gen.Spider
removeScanPolicy(String) - Method in class org.zaproxy.clientapi.gen.Ascan
removeScanPolicy(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
removeSession(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.HttpSessionsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
removeSession(String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Removes the session from the given site.
removeSessionToken(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.HttpSessionsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
removeSessionToken(String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Removes the session token from the given site.
removeUser(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.UsersDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
removeUser(String, String) - Method in class org.zaproxy.clientapi.gen.Users: Removes the user with the given ID that belongs to the context with the given ID.
renameSession(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.HttpSessionsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
renameSession(String, String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Renames the session of the given site.
replacer - Variable in class org.zaproxy.clientapi.core.ClientApi
Replacer - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Replacer(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Replacer
results(String, String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
results(String) - Method in class org.zaproxy.clientapi.gen.Spider
resume(String) - Method in class org.zaproxy.clientapi.gen.Ascan
resume(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
resume(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
resume(String) - Method in class org.zaproxy.clientapi.gen.Spider
resumeAllScans() - Method in class org.zaproxy.clientapi.gen.Ascan
resumeAllScans(String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
resumeAllScans(String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
resumeAllScans() - Method in class org.zaproxy.clientapi.gen.Spider
reveal - Variable in class org.zaproxy.clientapi.core.ClientApi
Reveal - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Reveal(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Reveal
reveal() - Method in class org.zaproxy.clientapi.gen.Reveal: Tells if shows hidden fields and enables disabled fields
RevealDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
RevealDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.RevealDeprecated
rootcert() - Method in class org.zaproxy.clientapi.gen.Core: Gets the Root CA certificate used by the local proxies.
rootcert(String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
rules() - Method in class org.zaproxy.clientapi.gen.Replacer: Returns full details of all of the rules
runGarbageCollection() - Method in class org.zaproxy.clientapi.gen.Core
runGarbageCollection(String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
runStandAloneScript(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ScriptDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
runStandAloneScript(String) - Method in class org.zaproxy.clientapi.gen.Script: Runs the stand alone script with the given name

S

saveAlertsToFile(List<Alert>, List<Alert>, List<Alert>, File) - Static method in class org.zaproxy.clientapi.core.AlertsFile
saveSession(String, String) - Method in class org.zaproxy.clientapi.gen.Core: Saves the session with the name supplied, optionally overwriting existing files.
saveSession(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
scan(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Runs the spider against the given URL and/or context, optionally, spidering everything in scope.
scan(String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan
scan(String, String, String, String, String, String, Integer) - Method in class org.zaproxy.clientapi.gen.Ascan: Runs the active scanner against the given URL and/or Context.
scan(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
scan(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
scan(String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
scan(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Spider: Runs the spider against the given URL (or context).
scanAsUser(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Runs the spider from the perspective of a User, obtained using the given context name and user name.
scanAsUser(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan: Active Scans from the perspective of a User, obtained using the given Context ID and User ID.
scanAsUser(String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
scanAsUser(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
scanAsUser(String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Spider: Runs the spider from the perspective of a User, obtained using the given Context ID and User ID.
scanners(String, String) - Method in class org.zaproxy.clientapi.gen.Ascan: Gets the scanners, optionally, of the given scan policy and/or scanner policy/category ID.
scanners() - Method in class org.zaproxy.clientapi.gen.Pscan: Lists all passive scanners with its ID, name, enabled state and alert threshold.
scanOnlyInScope() - Method in class org.zaproxy.clientapi.gen.Pscan: Tells whether or not the passive scan should be performed only on messages that are in scope.
scanPolicyNames() - Method in class org.zaproxy.clientapi.gen.Ascan
scanProgress(String) - Method in class org.zaproxy.clientapi.gen.Ascan
scans() - Method in class org.zaproxy.clientapi.gen.Ascan
scans() - Method in class org.zaproxy.clientapi.gen.Spider
script - Variable in class org.zaproxy.clientapi.core.ClientApi
Script - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Script(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Script
ScriptDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
ScriptDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.ScriptDeprecated
scriptVar(String, String) - Method in class org.zaproxy.clientapi.gen.Script: Gets the value of the variable with the given key for the given script.
scriptVars(String) - Method in class org.zaproxy.clientapi.gen.Script: Gets all the variables (key/value pairs) of the given script.
search - Variable in class org.zaproxy.clientapi.core.ClientApi
Search - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Search(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Search
SearchDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
SearchDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.SearchDeprecated
selenium - Variable in class org.zaproxy.clientapi.core.ClientApi
Selenium - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Selenium(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Selenium
SeleniumDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
SeleniumDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.SeleniumDeprecated
sendHarRequest(String, String) - Method in class org.zaproxy.clientapi.gen.Core: Sends the first HAR request entry, optionally following redirections.
sendHarRequest(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
sendRequest(String, String) - Method in class org.zaproxy.clientapi.gen.Core: Sends the HTTP request, optionally following redirections.
sendRequest(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
sendTextMessage(String, String, String) - Method in class org.zaproxy.clientapi.gen.Websocket: Sends the specified message on the channel specified by channelId, if outgoing is 'True' then the message will be sent to the server and if it is 'False' then it will be sent to the client
service(String) - Method in class org.zaproxy.clientapi.gen.deprecated.PnhDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
service() - Method in class org.zaproxy.clientapi.gen.Pnh: This component is optional and therefore the API will only work if it is installed
sessionLocation() - Method in class org.zaproxy.clientapi.gen.Core: Gets the location of the current session file
sessionManagement - Variable in class org.zaproxy.clientapi.core.ClientApi
SessionManagement - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
SessionManagement(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.SessionManagement
SessionManagementDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
SessionManagementDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.SessionManagementDeprecated
sessions(String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Gets the sessions for the given site.
sessionTokens(String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Gets the names of the session tokens for the given site.
setActiveSession(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.HttpSessionsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setActiveSession(String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Sets the given session as active for the given site.
setAlert(String) - Method in class org.zaproxy.clientapi.core.Alert: Deprecated.
(1.1.0) Use Alert.setName(String) instead.
setAuthenticationCredentials(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.UsersDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setAuthenticationCredentials(String, String, String) - Method in class org.zaproxy.clientapi.gen.Users: Sets the authentication credentials for the user with the given ID that belongs to the context with the given ID.
setAuthenticationMethod(String, String, String) - Method in class org.zaproxy.clientapi.gen.Authentication: Sets the authentication method for the context with the given ID.
setAuthenticationMethod(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AuthenticationDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setBasicAuthorizationDetectionMethod(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Authorization: Sets the authorization detection method for a context as one that identifies un-authorized messages based on: the message's status code or a regex pattern in the response's header or body.
setBasicAuthorizationDetectionMethod(String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AuthorizationDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setBreakTextMessage(String, String) - Method in class org.zaproxy.clientapi.gen.Websocket: Sets the text message for an intercepted websockets message
setConfidence(Alert.Confidence) - Method in class org.zaproxy.clientapi.core.Alert
setConfidence(String) - Method in class org.zaproxy.clientapi.core.Alert
setContextInScope(String, String) - Method in class org.zaproxy.clientapi.gen.Context: Sets a context to in scope (contexts are in scope by default)
setContextInScope(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setContextRegexs(String, String, String) - Method in class org.zaproxy.clientapi.gen.Context: Set the regexs to include and exclude for a context, both supplied as JSON string arrays
setDebugStream(PrintStream) - Method in class org.zaproxy.clientapi.core.ClientApi
setDefaultSessionTokenEnabled(String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Sets whether or not the default session token with the given name is enabled.
setEnabled(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.PscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setEnabled(String) - Method in class org.zaproxy.clientapi.gen.Pscan: Sets whether or not the passive scanning is enabled (Note: the enabled state is not persisted).
setEnabled(String, String) - Method in class org.zaproxy.clientapi.gen.Replacer: Enables or disables the rule with the given description based on the bool parameter
setEnabledPolicies(String, String) - Method in class org.zaproxy.clientapi.gen.Ascan
setEnabledPolicies(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setForcedUser(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ForcedUserDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setForcedUser(String, String) - Method in class org.zaproxy.clientapi.gen.ForcedUser: Sets the user (ID) that should be used in 'forced user' mode for the given context (ID)
setForcedUserModeEnabled(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.ForcedUserDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setForcedUserModeEnabled(boolean) - Method in class org.zaproxy.clientapi.gen.ForcedUser: Sets if 'forced user' mode should be enabled or not
setGlobalVar(String, String) - Method in class org.zaproxy.clientapi.gen.Script: Sets the value of the global variable with the given key.
setHomeDirectory(String) - Method in class org.zaproxy.clientapi.gen.Core
setHomeDirectory(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setHttpMessage(String, String) - Method in class org.zaproxy.clientapi.gen.Break: Overwrites the currently intercepted message with the data provided
setLoggedInIndicator(String, String) - Method in class org.zaproxy.clientapi.gen.Authentication: Sets the logged in indicator for the context with the given ID.
setLoggedInIndicator(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AuthenticationDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setLoggedOutIndicator(String, String) - Method in class org.zaproxy.clientapi.gen.Authentication: Sets the logged out indicator for the context with the given ID.
setLoggedOutIndicator(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AuthenticationDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setMaxAlertsPerRule(String) - Method in class org.zaproxy.clientapi.gen.Pscan: Sets the maximum number of alerts a passive scan rule should raise.
setMode(String) - Method in class org.zaproxy.clientapi.gen.Core: Sets the mode, which may be one of [safe, protect, standard, attack]
setMode(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setName(String) - Method in class org.zaproxy.clientapi.core.Alert: Sets the name of the alert.
setName(String) - Method in class org.zaproxy.clientapi.core.ApiResponse
setOptionAcceptCookies(boolean) - Method in class org.zaproxy.clientapi.gen.Spider: Sets whether or not a spider process should accept cookies while spidering.
setOptionAddQueryParam(boolean) - Method in class org.zaproxy.clientapi.gen.Ascan: Sets whether or not the active scanner should add a query param to GET requests which do not have parameters to start with.
setOptionAlertOverridesFilePath(String) - Method in class org.zaproxy.clientapi.gen.Core: Sets (or clears, if empty) the path to the file with alert overrides.
setOptionAllowAttackOnStart(boolean) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionAllowAttackOnStart(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionAttackPolicy(String) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionAttackPolicy(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionBrowserId(String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
setOptionBrowserId(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionCheckAddonUpdates(boolean) - Method in class org.zaproxy.clientapi.gen.Autoupdate
setOptionCheckAddonUpdates(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AutoupdateDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionCheckOnStart(boolean) - Method in class org.zaproxy.clientapi.gen.Autoupdate
setOptionCheckOnStart(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AutoupdateDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionChromeDriverPath(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SeleniumDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionChromeDriverPath(String) - Method in class org.zaproxy.clientapi.gen.Selenium: Sets the current path to ChromeDriver
setOptionClickDefaultElems(boolean) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
setOptionClickDefaultElems(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionClickElemsOnce(boolean) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
setOptionClickElemsOnce(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionDefaultPolicy(String) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionDefaultPolicy(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionDefaultUserAgent(String) - Method in class org.zaproxy.clientapi.gen.Core: Sets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy).
setOptionDefaultUserAgent(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionDelayInMs(int) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionDelayInMs(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionDnsTtlSuccessfulQueries(int) - Method in class org.zaproxy.clientapi.gen.Core: Sets the TTL (in seconds) of successful DNS queries (applies after ZAP restart).
setOptionDownloadNewRelease(boolean) - Method in class org.zaproxy.clientapi.gen.Autoupdate
setOptionDownloadNewRelease(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AutoupdateDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionEventWait(int) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
setOptionEventWait(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionFirefoxBinaryPath(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SeleniumDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionFirefoxBinaryPath(String) - Method in class org.zaproxy.clientapi.gen.Selenium: Sets the current path to Firefox binary
setOptionFirefoxDriverPath(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SeleniumDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionFirefoxDriverPath(String) - Method in class org.zaproxy.clientapi.gen.Selenium: Sets the current path to Firefox driver (geckodriver)
setOptionHandleAntiCSRFTokens(boolean) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionHandleAntiCSRFTokens(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionHandleODataParametersVisited(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionHandleODataParametersVisited(boolean) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionHandleParameters(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionHandleParameters(String) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionHostPerScan(int) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionHostPerScan(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionHttpStateEnabled(boolean) - Method in class org.zaproxy.clientapi.gen.Core
setOptionHttpStateEnabled(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionIeDriverPath(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SeleniumDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionIeDriverPath(String) - Method in class org.zaproxy.clientapi.gen.Selenium: Deprecated.
setOptionInjectPluginIdInHeader(boolean) - Method in class org.zaproxy.clientapi.gen.Ascan: Sets whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scanner that's sending the requests.
setOptionInjectPluginIdInHeader(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionInMemoryEnabled(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.StatsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionInMemoryEnabled(boolean) - Method in class org.zaproxy.clientapi.gen.Stats: Sets whether in memory statistics are enabled
setOptionInstallAddonUpdates(boolean) - Method in class org.zaproxy.clientapi.gen.Autoupdate
setOptionInstallAddonUpdates(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AutoupdateDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionInstallScannerRules(boolean) - Method in class org.zaproxy.clientapi.gen.Autoupdate
setOptionInstallScannerRules(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AutoupdateDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionMaxChartTimeInMins(int) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionMaxChartTimeInMins(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionMaxChildren(int) - Method in class org.zaproxy.clientapi.gen.Spider: Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
setOptionMaxCrawlDepth(int) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
setOptionMaxCrawlDepth(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionMaxCrawlStates(int) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
setOptionMaxCrawlStates(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionMaxDepth(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionMaxDepth(int) - Method in class org.zaproxy.clientapi.gen.Spider: Sets the maximum depth the spider can crawl, 0 for unlimited depth.
setOptionMaxDuration(int) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
setOptionMaxDuration(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionMaxDuration(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionMaxDuration(int) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionMaximumAlertInstances(String) - Method in class org.zaproxy.clientapi.gen.Core: Sets the maximum number of alert instances to include in a report.
setOptionMaxParseSizeBytes(int) - Method in class org.zaproxy.clientapi.gen.Spider: Sets the maximum size, in bytes, that a response might have to be parsed.
setOptionMaxResultsToList(int) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionMaxResultsToList(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionMaxRuleDurationInMins(int) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionMaxScanDurationInMins(int) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionMaxScansInUI(int) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionMaxScansInUI(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionMaxScansInUI(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionMaxScansInUI(int) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionMergeRelatedAlerts(String) - Method in class org.zaproxy.clientapi.gen.Core: Sets whether or not related alerts will be merged in any reports generated.
setOptionNumberOfBrowsers(int) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
setOptionNumberOfBrowsers(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionParseComments(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionParseComments(boolean) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionParseGit(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionParseGit(boolean) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionParseRobotsTxt(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionParseRobotsTxt(boolean) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionParseSitemapXml(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionParseSitemapXml(boolean) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionParseSVNEntries(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionParseSVNEntries(boolean) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionPhantomJsBinaryPath(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SeleniumDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionPhantomJsBinaryPath(String) - Method in class org.zaproxy.clientapi.gen.Selenium: Sets the current path to PhantomJS binary
setOptionPostForm(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionPostForm(boolean) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionProcessForm(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionProcessForm(boolean) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionPromptInAttackMode(boolean) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionPromptInAttackMode(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionPromptToClearFinishedScans(boolean) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionPromptToClearFinishedScans(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionProxyChainName(String) - Method in class org.zaproxy.clientapi.gen.Core
setOptionProxyChainName(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionProxyChainPassword(String) - Method in class org.zaproxy.clientapi.gen.Core
setOptionProxyChainPassword(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionProxyChainPort(int) - Method in class org.zaproxy.clientapi.gen.Core
setOptionProxyChainPort(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionProxyChainPrompt(boolean) - Method in class org.zaproxy.clientapi.gen.Core
setOptionProxyChainPrompt(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionProxyChainRealm(String) - Method in class org.zaproxy.clientapi.gen.Core
setOptionProxyChainRealm(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionProxyChainSkipName(String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Option no longer in effective use.
setOptionProxyChainSkipName(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionProxyChainUserName(String) - Method in class org.zaproxy.clientapi.gen.Core
setOptionProxyChainUserName(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionRandomInputs(boolean) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
setOptionRandomInputs(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionReloadWait(int) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
setOptionReloadWait(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionReportAlphaAddons(boolean) - Method in class org.zaproxy.clientapi.gen.Autoupdate
setOptionReportAlphaAddons(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AutoupdateDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionReportBetaAddons(boolean) - Method in class org.zaproxy.clientapi.gen.Autoupdate
setOptionReportBetaAddons(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AutoupdateDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionReportReleaseAddons(boolean) - Method in class org.zaproxy.clientapi.gen.Autoupdate
setOptionReportReleaseAddons(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AutoupdateDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionRequestWaitTime(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionRequestWaitTime(int) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionRescanInAttackMode(boolean) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionRescanInAttackMode(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionScanHeadersAllRequests(boolean) - Method in class org.zaproxy.clientapi.gen.Ascan: Sets whether or not the HTTP Headers of all requests should be scanned.
setOptionScanHeadersAllRequests(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionScopeString(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionScopeString(String) - Method in class org.zaproxy.clientapi.gen.Spider: Deprecated.
Option no longer in effective use.
setOptionSendRefererHeader(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionSendRefererHeader(boolean) - Method in class org.zaproxy.clientapi.gen.Spider: Sets whether or not the 'Referer' header should be sent while spidering.
setOptionShowAdvancedDialog(boolean) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionShowAdvancedDialog(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionShowAdvancedDialog(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionShowAdvancedDialog(boolean) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionSingleCookieRequestHeader(boolean) - Method in class org.zaproxy.clientapi.gen.Core
setOptionSingleCookieRequestHeader(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionSkipURLString(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionSkipURLString(String) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionStatsdHost(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.StatsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionStatsdHost(String) - Method in class org.zaproxy.clientapi.gen.Stats: Sets the Statsd service hostname, supply an empty string to stop using a Statsd service
setOptionStatsdPort(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.StatsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionStatsdPort(int) - Method in class org.zaproxy.clientapi.gen.Stats: Sets the Statsd service port
setOptionStatsdPrefix(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.StatsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionStatsdPrefix(String) - Method in class org.zaproxy.clientapi.gen.Stats: Sets the prefix to be applied to all stats sent to the configured Statsd service
setOptionTargetParamsEnabledRPC(int) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionTargetParamsEnabledRPC(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionTargetParamsInjectable(int) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionTargetParamsInjectable(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionThreadCount(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionThreadCount(int) - Method in class org.zaproxy.clientapi.gen.Spider
setOptionThreadPerHost(int) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionThreadPerHost(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionTimeoutInSecs(int) - Method in class org.zaproxy.clientapi.gen.Core: Sets the connection time out, in seconds.
setOptionTimeoutInSecs(String, int) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionUseProxyChain(boolean) - Method in class org.zaproxy.clientapi.gen.Core: Sets whether or not the outgoing proxy should be used.
setOptionUseProxyChain(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionUseProxyChainAuth(boolean) - Method in class org.zaproxy.clientapi.gen.Core
setOptionUseProxyChainAuth(String, boolean) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionUserAgent(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setOptionUserAgent(String) - Method in class org.zaproxy.clientapi.gen.Spider
setOther(String) - Method in class org.zaproxy.clientapi.core.Alert
setParam(String) - Method in class org.zaproxy.clientapi.core.Alert
setPolicyAlertThreshold(String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan
setPolicyAlertThreshold(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setPolicyAttackStrength(String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan
setPolicyAttackStrength(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setproxy(String) - Method in class org.zaproxy.clientapi.gen.Core
setproxy(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setReliability(Alert.Reliability) - Method in class org.zaproxy.clientapi.core.Alert: Deprecated.
Alert.setConfidence(Confidence) Use of reliability has been deprecated in favour of using confidence
setReliability(String) - Method in class org.zaproxy.clientapi.core.Alert: Deprecated.
Alert.setConfidence(String) Use of reliability has been deprecated in favour of using confidence
setReveal(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.RevealDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setReveal(String) - Method in class org.zaproxy.clientapi.gen.Reveal: Sets if shows hidden fields and enables disabled fields
setRisk(Alert.Risk) - Method in class org.zaproxy.clientapi.core.Alert
setRisk(String) - Method in class org.zaproxy.clientapi.core.Alert
setScannerAlertThreshold(String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan
setScannerAlertThreshold(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setScannerAlertThreshold(String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.PscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setScannerAlertThreshold(String, String) - Method in class org.zaproxy.clientapi.gen.Pscan: Sets the alert threshold of the passive scanner with the given ID, accepted values for alert threshold: OFF, DEFAULT, LOW, MEDIUM and HIGH
setScannerAttackStrength(String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan
setScannerAttackStrength(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setScanOnlyInScope(String) - Method in class org.zaproxy.clientapi.gen.Pscan: Sets whether or not the passive scan should be performed only on messages that are in scope.
setScriptVar(String, String, String) - Method in class org.zaproxy.clientapi.gen.Script: Sets the value of the variable with the given key of the given script.
setSessionManagementMethod(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SessionManagementDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setSessionManagementMethod(String, String, String) - Method in class org.zaproxy.clientapi.gen.SessionManagement: Sets the session management method for the context with the given ID.
setSessionTokenValue(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.HttpSessionsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setSessionTokenValue(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Sets the value of the session token of the given session for the given site.
setUrl(String) - Method in class org.zaproxy.clientapi.core.Alert
setUserEnabled(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.UsersDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setUserEnabled(String, String, String) - Method in class org.zaproxy.clientapi.gen.Users: Sets whether or not the user, with the given ID that belongs to the context with the given ID, should be enabled.
setUserName(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.UsersDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
setUserName(String, String, String) - Method in class org.zaproxy.clientapi.gen.Users: Renames the user with the given ID that belongs to the context with the given ID.
shutdown() - Method in class org.zaproxy.clientapi.gen.Core: Shuts down ZAP
shutdown(String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
sites() - Method in class org.zaproxy.clientapi.gen.Core: Gets the sites accessed through/by ZAP (scheme and domain)
sites() - Method in class org.zaproxy.clientapi.gen.HttpSessions: Gets all of the sites that have sessions.
siteStats(String, String) - Method in class org.zaproxy.clientapi.gen.Stats: Gets all of the global statistics, optionally filtered by a key prefix
skipScanner(String, String) - Method in class org.zaproxy.clientapi.gen.Ascan: Skips the scanner using the given IDs of the scan and the scanner.
snapshotSession(String, String) - Method in class org.zaproxy.clientapi.gen.Core: Snapshots the session, optionally with the given name, and overwriting existing files.
snapshotSession(String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
snapshotSession() - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated
soap - Variable in class org.zaproxy.clientapi.core.ClientApi
Soap - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Soap(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Soap
spider - Variable in class org.zaproxy.clientapi.core.ClientApi
Spider - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Spider(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Spider
SpiderDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
SpiderDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated
startMonitoring(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.PnhDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
startMonitoring(String) - Method in class org.zaproxy.clientapi.gen.Pnh: This component is optional and therefore the API will only work if it is installed
stats - Variable in class org.zaproxy.clientapi.core.ClientApi
Stats - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Stats(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Stats
stats(String) - Method in class org.zaproxy.clientapi.gen.Stats: Statistics
StatsDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
StatsDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.StatsDeprecated
status() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
status(String) - Method in class org.zaproxy.clientapi.gen.Ascan
status(String) - Method in class org.zaproxy.clientapi.gen.Spider
step() - Method in class org.zaproxy.clientapi.gen.Break: Submits the currently intercepted message, the next request or response will automatically be intercepted
stop() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: This component is optional and therefore the API will only work if it is installed
stop(String) - Method in class org.zaproxy.clientapi.gen.Ascan
stop(String) - Method in class org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
stop(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
stop(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
stop(String) - Method in class org.zaproxy.clientapi.gen.Spider
stopAllScans() - Method in class org.zaproxy.clientapi.gen.Ascan
stopAllScans(String) - Method in class org.zaproxy.clientapi.gen.deprecated.AscanDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
stopAllScans(String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
stopAllScans() - Method in class org.zaproxy.clientapi.gen.Spider
stopMonitoring(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.PnhDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
stopMonitoring(String) - Method in class org.zaproxy.clientapi.gen.Pnh: This component is optional and therefore the API will only work if it is installed

T

technologyList() - Method in class org.zaproxy.clientapi.gen.Context: Lists the names of all built in technologies
toString() - Method in class org.zaproxy.clientapi.core.Alert
toString(int) - Method in class org.zaproxy.clientapi.core.ApiResponse
toString(int) - Method in class org.zaproxy.clientapi.core.ApiResponseElement
toString() - Method in class org.zaproxy.clientapi.core.ApiResponseElement
toString(int) - Method in class org.zaproxy.clientapi.core.ApiResponseList
toString(int) - Method in class org.zaproxy.clientapi.core.ApiResponseSet

U

uninstallAddon(String) - Method in class org.zaproxy.clientapi.gen.Autoupdate: Uninstalls the specified add-on
unsetActiveSession(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.HttpSessionsDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).
unsetActiveSession(String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Unsets the active session of the given site.
updatedAddons() - Method in class org.zaproxy.clientapi.gen.Autoupdate: Return a list of any add-ons that have been changed in the Marketplace since the last check for updates
updateScanPolicy(String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan
urls(String) - Method in class org.zaproxy.clientapi.gen.Context: Lists the URLs accessed through/by ZAP, that belong to the context with the given name.
urls(String) - Method in class org.zaproxy.clientapi.gen.Core: Gets the URLs accessed through/by ZAP, optionally filtering by (base) URL.
urls() - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Gets the URLs accessed through/by ZAP
urlsByHeaderRegex(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Search: Returns the URLs of the HTTP messages that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
urlsByRequestRegex(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Search: Returns the URLs of the HTTP messages that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
urlsByResponseRegex(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Search: Returns the URLs of the HTTP messages that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
urlsByUrlRegex(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Search: Returns the URLs of the HTTP messages that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
users - Variable in class org.zaproxy.clientapi.core.ClientApi
Users - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Users(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Users
UsersDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
UsersDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.UsersDeprecated
usersList(String) - Method in class org.zaproxy.clientapi.gen.Users: Gets a list of users that belong to the context with the given ID, or all users if none provided.

V

valueOf(String) - Static method in enum org.zaproxy.clientapi.core.Alert.Confidence: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.zaproxy.clientapi.core.Alert.Reliability: Deprecated.

Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.zaproxy.clientapi.core.Alert.Risk: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.zaproxy.clientapi.core.Alert.Confidence: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.zaproxy.clientapi.core.Alert.Reliability: Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.zaproxy.clientapi.core.Alert.Risk: Returns an array containing the constants of this enum type, in the order they are declared.
version() - Method in class org.zaproxy.clientapi.gen.Core: Gets ZAP version

W

waitForSuccessfulConnectionToZap(int) - Method in class org.zaproxy.clientapi.core.ClientApi: Convenience method to wait for ZAP to be ready to receive API calls, when started programmatically.
waitForSuccessfulConnectionToZap(int, int) - Method in class org.zaproxy.clientapi.core.ClientApi: Convenience method to wait for ZAP to be ready to receive API calls, when started programmatically.
websocket - Variable in class org.zaproxy.clientapi.core.ClientApi
Websocket - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Websocket(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Websocket

X

xmlreport() - Method in class org.zaproxy.clientapi.gen.Core: Generates a report in XML format
xmlreport(String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Deprecated.
(1.1.0) Use the method without the API key and use one of the ClientApi constructors that allow to set the API key (e.g. ClientApi.ClientApi(String, int, String)).

Z

zapHomePath() - Method in class org.zaproxy.clientapi.gen.Core: Gets the path to ZAP's home directory.

A B C D E F G H I J L M N O P R S T U V W X Z