Index (zap-clientapi 1.13.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
All Classes All Packages

A

accessControl - Variable in class org.zaproxy.clientapi.core.ClientApi
AccessControl - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
AccessControl(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.AccessControl
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(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) - Method in class org.zaproxy.clientapi.core.ClientApi: Active scans the given site, that's in scope.
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.
activeSession(String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Gets the name of the active session for the given site.
addAdditionalProxy(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.LocalProxies: Deprecated.

Adds an new proxy using the details supplied.
addAlert(String, String, String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Alert: Add an alert associated with the given message ID, with the provided details.
addAlertFilter(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AlertFilterDeprecated: Adds a new alert filter for the context with the given ID.
addAlertFilter(String, String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AlertFilterDeprecated: Adds a new alert filter for the context with the given ID.
addAlertFilter(String, String, String, String, String, String, 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.
addAlertFilter(String, String, String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AlertFilterDeprecated: Adds a new alert filter for the context with the given ID.
addAlias(String, String) - Method in class org.zaproxy.clientapi.gen.Network: Adds an alias for the local servers/proxies.
addAllowedResource(String, String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Adds an allowed resource.
addBrowserArgument(String, String, String) - Method in class org.zaproxy.clientapi.gen.Selenium: Adds a browser argument.
addCustomPayload(String, String) - Method in class org.zaproxy.clientapi.gen.Custompayloads: Adds a new payload.
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.
addExcludedElement(String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Adds an excluded element to a context.
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.
addGlobalAlertFilter(String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AlertFilterDeprecated: Adds a new global alert filter.
addGlobalAlertFilter(String, String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.AlertFilter: Adds a new global alert filter.
addGlobalAlertFilter(String, String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AlertFilterDeprecated: Adds a new global alert filter.
addHttpBreakpoint(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Break: Adds a custom HTTP breakpoint.
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(String, int, String)).
addHttpProxyExclusion(String, String) - Method in class org.zaproxy.clientapi.gen.Network: Adds a host to be excluded from the HTTP proxy.
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
additionalProxies() - Method in class org.zaproxy.clientapi.gen.LocalProxies: Deprecated.

Gets all of the additional proxies that have been configured.
addLocalServer(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Network: Adds a local server/proxy.
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(String, int, String)).
addPassThrough(String, String) - Method in class org.zaproxy.clientapi.gen.Network: Adds an authority to pass-through the local proxies.
addPkcs12ClientCertificate(String, String, String) - Method in class org.zaproxy.clientapi.gen.Network: Adds a client certificate contained in a PKCS#12 file, the certificate is automatically set as active and used.
addProxyChainExcludedDomain(String, String, String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
addRateLimitRule(String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Network: Adds a rate limit rule
addRule(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.ReplacerDeprecated: Deprecated.
(1.11.0) Use the method with the url.
addRule(String, 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.deprecated.AscanDeprecated: Deprecated.
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(String, int, String)).
addScanPolicy(String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan
addSessionToken(String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Adds the session token to the given site.
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(String, int, String)).
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 - Variable in class org.zaproxy.clientapi.core.ClientApi
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 - Class in org.zaproxy.clientapi.core
Alert - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Alert(String, String) - Constructor for class org.zaproxy.clientapi.core.Alert
Alert(String, String, String, String, 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, Alert.Risk, Alert.Confidence, 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(ApiResponseSet) - Constructor for class org.zaproxy.clientapi.core.Alert: Constructs an Alert from the given ApiResponseSet.
Alert(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Alert
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
AlertFilterDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
AlertFilterDeprecated() - Constructor for class org.zaproxy.clientapi.gen.deprecated.AlertFilterDeprecated
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) - 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
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, 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
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.
allowedResources() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Gets the allowed resources.
allRuleConfigs() - Method in class org.zaproxy.clientapi.gen.RuleConfig: Show all of the rule configurations
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) - Constructor for class org.zaproxy.clientapi.core.ApiResponseElement
ApiResponseElement(Node, ApiResponse) - 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(String, List<ApiResponse>) - Constructor for class org.zaproxy.clientapi.core.ApiResponseList
ApiResponseList(String, ApiResponse[]) - 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
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
applyAll() - Method in class org.zaproxy.clientapi.gen.AlertFilter: Applies all currently enabled Global and Context alert filters.
applyContext() - Method in class org.zaproxy.clientapi.gen.AlertFilter: Applies all currently enabled Context alert filters.
applyGlobal() - Method in class org.zaproxy.clientapi.gen.AlertFilter: Applies all currently enabled Global alert filters.
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
authenticateAsUser(String, String) - Method in class org.zaproxy.clientapi.gen.Users: Tries to authenticate as the identified user, returning the authentication request and whether it appears to have succeeded.
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
automation - Variable in class org.zaproxy.clientapi.core.ClientApi
Automation - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Automation(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Automation
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(String, int, String)).

C

callApi(String, String, String, String, Map<String, String>) - Method in class org.zaproxy.clientapi.core.ClientApi
callApi(String, String, String, Map<String, String>) - Method in class org.zaproxy.clientapi.core.ClientApi
callApiOther(String, 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(String, int, String)).
clearExcludedFromScan() - Method in class org.zaproxy.clientapi.gen.Ascan: Clears the regexes of URLs excluded from the active scans.
clearExcludedFromScan() - Method in class org.zaproxy.clientapi.gen.Spider: Clears the regexes of URLs excluded from the spider 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(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(String, int, String)).
clearGlobalCustomVar(String) - Method in class org.zaproxy.clientapi.gen.Script: Clears a global custom variable.
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.
clearQueue() - Method in class org.zaproxy.clientapi.gen.Pscan: Clears the passive scan queue.
clearScriptCustomVar(String, String) - Method in class org.zaproxy.clientapi.gen.Script: Clears a script custom variable.
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) - Method in class org.zaproxy.clientapi.gen.Stats: Clears all of the statistics
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(String, int, String)).
ClientApi - Class in org.zaproxy.clientapi.core
ClientApi(String, int) - Constructor for class org.zaproxy.clientapi.core.ClientApi
ClientApi(String, int, boolean) - 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, 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
Confirmed - org.zaproxy.clientapi.core.Alert.Confidence
cont() - Method in class org.zaproxy.clientapi.gen.Break: Submits the currently intercepted message and unsets the global request/response breakpoints
context - Variable in class org.zaproxy.clientapi.core.ClientApi
context(String) - Method in class org.zaproxy.clientapi.gen.Context: List the information about the named context
Context - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Context(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.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) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Creates an empty session for the given site.
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(String, int, String)).
createSbomZip(String) - Method in class org.zaproxy.clientapi.gen.Core: Create a zip file of the ZAP core and add-on SBOMs
currentRule() - Method in class org.zaproxy.clientapi.gen.Pscan: Deprecated.
Use the currentTasks view instead.
currentTasks() - Method in class org.zaproxy.clientapi.gen.Pscan: Show information about the passive scan tasks currently being run (if any).
customPayloads(String) - Method in class org.zaproxy.clientapi.gen.Custompayloads: Lists all the payloads currently loaded (category, payload, enabled state).
Custompayloads - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Custompayloads(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Custompayloads
customPayloadsCategories() - Method in class org.zaproxy.clientapi.gen.Custompayloads: Lists all available categories.

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.
deleteAlerts(String, String, String) - Method in class org.zaproxy.clientapi.gen.Alert: Deletes all the alerts optionally filtered by URL which fall within the Context with the provided name, risk, or base URL.
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(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(String, int, String)).
disable(String) - Method in class org.zaproxy.clientapi.gen.Script: Disables the script with the given name
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(String, int, String)).
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: Deprecated.
Use the API endpoints in the 'network' component instead.
disableAllScanners() - Method in class org.zaproxy.clientapi.gen.Pscan: Disables all passive scan rules
disableAllScanners(String) - Method in class org.zaproxy.clientapi.gen.Ascan: Disables all scan rules of the scan policy with the given name, or the default if none given.
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(String, int, String)).
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(String, int, String)).
disableAllTags() - Method in class org.zaproxy.clientapi.gen.Pscan: Disables all passive scan tags.
disableClientCertificate() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
disableCustomPayload(String, String) - Method in class org.zaproxy.clientapi.gen.Custompayloads: Disables a given payload.
disableCustomPayloads(String) - Method in class org.zaproxy.clientapi.gen.Custompayloads: Disables payloads for a given category.
disableScanners(String) - Method in class org.zaproxy.clientapi.gen.Pscan: Disables all passive scan rules with the given IDs (comma separated list of IDs)
disableScanners(String, String) - Method in class org.zaproxy.clientapi.gen.Ascan: Disables the scan rules 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) - 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(String, int, String)).
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(String, int, String)).
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(String, int, String)).
drop() - Method in class org.zaproxy.clientapi.gen.Break: Drops the currently intercepted message

E

enable(String) - Method in class org.zaproxy.clientapi.gen.Script: Enables the script with the given name
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(String, int, String)).
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: Deprecated.
Use the API endpoints in the 'network' component instead.
enableAllScanners() - Method in class org.zaproxy.clientapi.gen.Pscan: Enables all passive scan rules
enableAllScanners(String) - Method in class org.zaproxy.clientapi.gen.Ascan: Enables all scan rules of the scan policy with the given name, or the default if none given.
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(String, int, String)).
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(String, int, String)).
enableAllTags() - Method in class org.zaproxy.clientapi.gen.Pscan: Enables all passive scan tags.
enableCustomPayload(String, String) - Method in class org.zaproxy.clientapi.gen.Custompayloads: Enables a given payload.
enableCustomPayloads(String) - Method in class org.zaproxy.clientapi.gen.Custompayloads: Enables payloads for a given category.
enablePKCS12ClientCertificate(String, String, String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
enableScanners(String) - Method in class org.zaproxy.clientapi.gen.Pscan: Enables all passive scan rules with the given IDs (comma separated list of IDs)
enableScanners(String, String) - Method in class org.zaproxy.clientapi.gen.Ascan: Enables the scan rules 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) - 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(String, int, String)).
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(String, int, String)).
endDelayJob() - Method in class org.zaproxy.clientapi.gen.Automation: This component is optional and therefore the API will only work if it is installed
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(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(String, int, String)).
excludedElements(String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Gets the excluded elements.
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(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(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) - Method in class org.zaproxy.clientapi.gen.Spider: Adds a regex of URLs that should be excluded from the spider 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(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(String, int, String)).
excludeRegexs(String) - Method in class org.zaproxy.clientapi.gen.Context: List excluded regexs for context
exim - Variable in class org.zaproxy.clientapi.core.ClientApi
Exim - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Exim(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Exim
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(String, int, String)).
exportHar(String, String, String) - Method in class org.zaproxy.clientapi.gen.Exim: Gets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages
exportHarById(String) - Method in class org.zaproxy.clientapi.gen.Exim: Gets the HTTP messages with the given IDs, in HAR format.
exportreport - Variable in class org.zaproxy.clientapi.core.ClientApi
Exportreport - Class in org.zaproxy.clientapi.gen: Deprecated, for removal: This API element is subject to removal in a future version.
Exportreport(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Exportreport: Deprecated.

F

FAIL - Static variable in class org.zaproxy.clientapi.core.ApiResponseElement
FalsePositive - org.zaproxy.clientapi.core.Alert.Confidence
fileDownload(String) - Method in class org.zaproxy.clientapi.gen.Core: Download a file from the transfer directory
fileUpload(String, String) - Method in class org.zaproxy.clientapi.gen.Core: Upload a file to the transfer directory.
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
formats() - Method in class org.zaproxy.clientapi.gen.Exportreport: Deprecated.

This component is optional and therefore the API will only work if it is installed
fullResults() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Gets the full crawled content detected by the AJAX Spider.
fullResults(String) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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
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(String, int, String)).

G

generate(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Exportreport: Deprecated.

This component is optional and therefore the API will only work if it is installed
generate(String, String, String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Reports: Generate a report with the supplied parameters.
generateRootCA() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
generateRootCaCert() - Method in class org.zaproxy.clientapi.gen.Network: Generates a new Root CA certificate, used to issue server certificates.
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(String, int, String)).
genFormActionUrl(String, String) - Method in class org.zaproxy.clientapi.gen.Acsrf: Generate a form for testing lack of anti-CSRF tokens - typically invoked via ZAP
genFormWithUrl(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AcsrfDeprecated: Generate a form for testing lack of anti-CSRF tokens - typically invoked via ZAP
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
getAliases() - Method in class org.zaproxy.clientapi.gen.Network: Gets the aliases used to identify the local servers/proxies.
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.
getAuthenticationSession(String, String) - Method in class org.zaproxy.clientapi.gen.Users: Gets the authentication session information for the user identified by the Context and User Ids, e.g.
getAuthenticationState(String, String) - Method in class org.zaproxy.clientapi.gen.Users: Gets the authentication state information for the user identified by the Context and User Ids.
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.
getBrowserArguments(String) - Method in class org.zaproxy.clientapi.gen.Selenium: Gets the browser arguments.
getCode() - Method in exception org.zaproxy.clientapi.core.ClientApiException
getConfidence() - Method in class org.zaproxy.clientapi.core.Alert
getConnectionTimeout() - Method in class org.zaproxy.clientapi.gen.Network: Gets the connection timeout, in seconds.
getCweId() - Method in class org.zaproxy.clientapi.core.Alert
getDefaultUserAgent() - Method in class org.zaproxy.clientapi.gen.Network: Gets the default user-agent.
getDescription() - Method in class org.zaproxy.clientapi.core.Alert
getDetail() - Method in exception org.zaproxy.clientapi.core.ClientApiException
getDnsTtlSuccessfulQueries() - Method in class org.zaproxy.clientapi.gen.Network: Gets the TTL (in seconds) of successful DNS queries.
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)
getHttpProxy() - Method in class org.zaproxy.clientapi.gen.Network: Gets the HTTP proxy.
getHttpProxyExclusions() - Method in class org.zaproxy.clientapi.gen.Network: Gets the HTTP proxy exclusions.
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.
getLocalServers() - Method in class org.zaproxy.clientapi.gen.Network: Gets the local servers/proxies.
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
getPassThroughs() - Method in class org.zaproxy.clientapi.gen.Network: Gets the authorities that will pass-through the local proxies.
getPluginId() - Method in class org.zaproxy.clientapi.core.Alert: Gets the ID of the plugin/scanner that raised the alert.
getRateLimitRules() - Method in class org.zaproxy.clientapi.gen.Network: List of rate limit rules.
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
getRootCaCertValidity() - Method in class org.zaproxy.clientapi.gen.Network: Gets the Root CA certificate validity, in days.
getScanProgress(String) - Method in class org.zaproxy.clientapi.gen.AccessControl: Gets the Access Control scan progress (percentage integer) for the given context ID.
getScanStatus(String) - Method in class org.zaproxy.clientapi.gen.AccessControl: Gets the Access Control scan status (description string) for the given context ID.
getServerCertValidity() - Method in class org.zaproxy.clientapi.gen.Network: Gets the server certificate validity, in days.
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.
getSocksProxy() - Method in class org.zaproxy.clientapi.gen.Network: Gets the SOCKS proxy.
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
globalAlertFilterList() - Method in class org.zaproxy.clientapi.gen.AlertFilter: Lists the global alert filters.
globalCustomVar(String) - Method in class org.zaproxy.clientapi.gen.Script: Gets the value (string representation) of a global custom variable.
globalCustomVars() - Method in class org.zaproxy.clientapi.gen.Script: Gets all the global custom variables (key/value pairs, the value is the string representation).
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).
graphql - Variable in class org.zaproxy.clientapi.core.ClientApi
Graphql - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Graphql(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Graphql

H

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.
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(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.
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(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.
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(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.
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(String, int, String)).
hashCode() - Method in class org.zaproxy.clientapi.core.Alert
High - org.zaproxy.clientapi.core.Alert.Confidence
High - org.zaproxy.clientapi.core.Alert.Risk
homeDirectory() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
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: Deprecated.
Use the 'generate' API endpoint the 'reports' component instead.
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(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(String, int, String)).
importFile(String) - Method in class org.zaproxy.clientapi.gen.deprecated.OpenapiDeprecated: Imports 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.
importFile(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.OpenapiDeprecated: Imports an OpenAPI definition from a local file.
importFile(String, String) - Method in class org.zaproxy.clientapi.gen.Graphql: Imports a GraphQL Schema from a File.
importFile(String, String, String) - Method in class org.zaproxy.clientapi.gen.Openapi: Imports an OpenAPI definition from a local file.
importHar(String) - Method in class org.zaproxy.clientapi.gen.Exim: Imports a HAR file.
ImportLogFiles - Class in org.zaproxy.clientapi.gen: Deprecated, for removal: This API element is subject to removal in a future version.
Use Exim instead.
ImportLogFiles(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.ImportLogFiles: Deprecated.
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
importModsec2Logs(String) - Method in class org.zaproxy.clientapi.gen.Exim: Imports ModSecurity2 logs from the file with the given file system path.
ImportModSecurityLogFromFile(String) - Method in class org.zaproxy.clientapi.gen.ImportLogFiles: Deprecated.

This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
importRootCaCert(String) - Method in class org.zaproxy.clientapi.gen.Network: Imports a Root CA certificate to be used to issue server certificates.
importScanPolicy(String) - Method in class org.zaproxy.clientapi.gen.Ascan: Imports a Scan Policy using the given file system path.
importUrl(String) - Method in class org.zaproxy.clientapi.gen.Soap: Import a WSDL definition from a URL.
importUrl(String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.OpenapiDeprecated: Imports an OpenAPI definition from a URL.
importUrl(String, String) - Method in class org.zaproxy.clientapi.gen.Graphql: Imports a GraphQL Schema from a URL.
importUrl(String, String, String) - Method in class org.zaproxy.clientapi.gen.Openapi: Imports an OpenAPI definition from a URL.
importurls - Variable in class org.zaproxy.clientapi.core.ClientApi
importurls(String) - Method in class org.zaproxy.clientapi.gen.Importurls: Deprecated.

Imports URLs (one per line) from the file with the given file system path.
importUrls(String) - Method in class org.zaproxy.clientapi.gen.Exim: Imports URLs (one per line) from the file with the given file system path.
Importurls - Class in org.zaproxy.clientapi.gen: Deprecated, for removal: This API element is subject to removal in a future version.
Use Exim instead.
Importurls(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Importurls: Deprecated.
ImportZAPHttpRequestResponsePair(String, String) - Method in class org.zaproxy.clientapi.gen.ImportLogFiles: Deprecated.

This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
ImportZAPLogFromFile(String) - Method in class org.zaproxy.clientapi.gen.ImportLogFiles: Deprecated.

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(String, int, String)).
importZapLogs(String) - Method in class org.zaproxy.clientapi.gen.Exim: Imports previously exported ZAP messages from the file with the given file system path.
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(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(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(String, int, String)).
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.
includeOneMatchingNodeInContext(String, String, String) - Method in class org.zaproxy.clientapi.core.ClientApi: Deprecated.
(1.1.0) Use ClientApi.includeOneMatchingNodeInContext(String, String) instead.
includeRegexs(String) - Method in class org.zaproxy.clientapi.gen.Context: List included regexs for context
Informational - org.zaproxy.clientapi.core.Alert.Risk
installAddon(String) - Method in class org.zaproxy.clientapi.gen.Autoupdate: Installs or updates the specified add-on, returning when complete (i.e.
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
isHttpProxyAuthEnabled() - Method in class org.zaproxy.clientapi.gen.Network: Tells whether or not the HTTP proxy authentication is enabled.
isHttpProxyEnabled() - Method in class org.zaproxy.clientapi.gen.Network: Tells whether or not the HTTP proxy is enabled.
isLatestVersion() - Method in class org.zaproxy.clientapi.gen.Autoupdate: Returns 'true' if ZAP is on the latest version
isSocksProxyEnabled() - Method in class org.zaproxy.clientapi.gen.Network: Tells whether or not the SOCKS proxy is enabled.
isUseGlobalHttpState() - Method in class org.zaproxy.clientapi.gen.Network: Tells whether or not to use global HTTP state.

J

jsonreport() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the 'generate' API endpoint the 'reports' component instead.

L

latestVersionNumber() - Method in class org.zaproxy.clientapi.gen.Autoupdate: Returns the latest version number
listAll() - Method in class org.zaproxy.clientapi.gen.Wappalyzer: Lists all sites and their associated applications (technologies).
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.
listSite(String) - Method in class org.zaproxy.clientapi.gen.Wappalyzer: Lists all the applications (technologies) associated with a specific site.
listSites() - Method in class org.zaproxy.clientapi.gen.Wappalyzer: Lists all the sites recognized by the wappalyzer addon.
listTypes() - Method in class org.zaproxy.clientapi.gen.Script: Lists the script types available.
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, 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(String, int, String)).
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(String, int, String)).
localAddons() - Method in class org.zaproxy.clientapi.gen.Autoupdate: Returns a list with all local add-ons, installed or not.
localProxies - Variable in class org.zaproxy.clientapi.core.ClientApi
LocalProxies - Class in org.zaproxy.clientapi.gen: Deprecated, for removal: This API element is subject to removal in a future version.
Use Network instead.
LocalProxies(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.LocalProxies: Deprecated.
logImportFiles - Variable in class org.zaproxy.clientapi.core.ClientApi
Low - org.zaproxy.clientapi.core.Alert.Confidence
Low - org.zaproxy.clientapi.core.Alert.Risk

M

main(String[]) - Static method in class org.zaproxy.clientapi.core.ClientApiMain
manifest() - Method in class org.zaproxy.clientapi.gen.Pnh: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
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: Deprecated.
Use the 'generate' API endpoint the 'reports' component instead.
Medium - org.zaproxy.clientapi.core.Alert.Confidence
Medium - org.zaproxy.clientapi.core.Alert.Risk
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: Deprecated.
Use the API endpoints in the 'exim' add-on instead.
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(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: Deprecated.
Use the API endpoints in the 'exim' add-on instead.
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(String, int, String)).
messagesHarById(String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'exim' add-on instead.
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.
modifyExcludedElement(String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Modifies an excluded element of a context.
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: Deprecated.
Use the API endpoints in the 'network' component instead.
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
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(String, int, String)).

N

network - Variable in class org.zaproxy.clientapi.core.ClientApi
Network - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Network(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Network
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(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(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.
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(String, int, String)).
numberOfAlerts(String) - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Gets the number of alerts, optionally filtering by URL
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.
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: Gets the number of resources found.

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
OpenapiDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
OpenapiDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.OpenapiDeprecated
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
optionArgsType() - Method in class org.zaproxy.clientapi.gen.Graphql: Returns how arguments are currently specified.
optionAttackPolicy() - Method in class org.zaproxy.clientapi.gen.Ascan
optionBrowserExtensions() - Method in class org.zaproxy.clientapi.gen.Selenium: This component is optional and therefore the API will only work if it is installed
optionBrowserId() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Gets the configured browser to use for crawling.
optionCheckAddonUpdates() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionCheckOnStart() - Method in class org.zaproxy.clientapi.gen.Autoupdate
optionChromeBinaryPath() - Method in class org.zaproxy.clientapi.gen.Selenium: Returns the current path to Chrome binary
optionChromeDriverPath() - Method in class org.zaproxy.clientapi.gen.Selenium: Returns the current path to ChromeDriver
optionClickDefaultElems() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Gets the configured value for 'Click Default Elements Only', HTML elements such as 'a', 'button', 'input', all associated with some action or links on the page.
optionClickElemsOnce() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Gets the value configured for the AJAX Spider to know if it should click on the elements only once.
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: Deprecated.
Use the API endpoints in the 'network' component instead.
optionDelayInMs() - Method in class org.zaproxy.clientapi.gen.Ascan: Deprecated.
Option no longer in effective use.
optionDnsTtlSuccessfulQueries() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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: Gets the time to wait after an event (in milliseconds).
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
optionFirefoxDefaultProfile() - Method in class org.zaproxy.clientapi.gen.Selenium: This component is optional and therefore the API will only work if it is installed
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: This component is optional and therefore the API will only work if it is installed
optionHandleParameters() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
optionHostPerScan() - Method in class org.zaproxy.clientapi.gen.Ascan
optionHttpState() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
optionHttpStateEnabled() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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 scan rule 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
optionLastDirectory() - Method in class org.zaproxy.clientapi.gen.Selenium: This component is optional and therefore the API will only work if it is installed
optionLenientMaxQueryDepthEnabled() - Method in class org.zaproxy.clientapi.gen.Graphql: Returns whether or not lenient maximum query generation depth is enabled.
optionMaxAdditionalQueryDepth() - Method in class org.zaproxy.clientapi.gen.Graphql: Returns the current maximum additional query generation depth.
optionMaxAlertsPerRule() - Method in class org.zaproxy.clientapi.gen.Ascan: Gets the maximum number of alerts that a rule can raise before being skipped.
optionMaxArgsDepth() - Method in class org.zaproxy.clientapi.gen.Graphql: Returns the current maximum arguments generation depth.
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: Gets the configured value for the max crawl depth.
optionMaxCrawlStates() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Gets the configured value for the maximum crawl states allowed.
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: Gets the configured max duration of the crawl, the value is in minutes.
optionMaxDuration() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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.
optionMaxQueryDepth() - Method in class org.zaproxy.clientapi.gen.Graphql: Returns the current maximum query generation depth.
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: This component is optional and therefore the API will only work if it is installed
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: Gets the configured number of browsers to be used.
optionOptionalArgsEnabled() - Method in class org.zaproxy.clientapi.gen.Graphql: Returns whether or not optional arguments are currently specified.
optionParseComments() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
optionParseDsStore() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
optionParseGit() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
optionParseRobotsTxt() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
optionParseSitemapXml() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
optionParseSVNEntries() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
optionPartialMatchingEnabled() - Method in class org.zaproxy.clientapi.gen.Acsrf: Define if ZAP should detect CSRF tokens by searching for partial matches
optionPhantomJsBinaryPath() - Method in class org.zaproxy.clientapi.gen.Selenium: Deprecated.
optionPostForm() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
optionProcessForm() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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: Deprecated.
Use the API endpoints in the 'network' component instead.
optionProxyChainPassword() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
optionProxyChainPort() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
optionProxyChainPrompt() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
optionProxyChainRealm() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
optionProxyChainSkipName() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
optionProxyChainUserName() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
optionProxyExcludedDomains() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
optionProxyExcludedDomainsEnabled() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
optionQueryGenEnabled() - Method in class org.zaproxy.clientapi.gen.Graphql: Returns whether the query generator is enabled.
optionQuerySplitType() - Method in class org.zaproxy.clientapi.gen.Graphql: Returns the current level for which a single query is generated.
optionRandomInputs() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Gets if the AJAX Spider will use random values in form fields when crawling, if set to true.
optionReloadWait() - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Gets the configured time to wait after reloading the page, this value is in milliseconds.
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
optionRequestMethod() - Method in class org.zaproxy.clientapi.gen.Graphql: Returns the current request method.
optionRequestWaitTime() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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.
optionScanNullJsonValues() - Method in class org.zaproxy.clientapi.gen.Ascan: Tells whether or not the active scanner should scan null JSON values.
optionScope() - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
Option no longer in effective use.
optionScopeText() - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
Option no longer in effective use.
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: This component is optional and therefore the API will only work if it is installed
optionSingleCookieRequestHeader() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Option no longer in effective use.
optionSkipURLString() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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: This component is optional and therefore the API will only work if it is installed
optionThreadPerHost() - Method in class org.zaproxy.clientapi.gen.Ascan
optionTimeoutInSecs() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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: Deprecated.
Use the API endpoints in the 'network' component instead.
optionUseProxyChainAuth() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
optionUserAgent() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
optionUseSocksProxy() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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
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(String, int, String)).
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) - Method in class org.zaproxy.clientapi.gen.ImportLogFiles: Deprecated.

This component is optional and therefore the API will only work if it is installed
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(String, int, String)).

P

params - Variable in class org.zaproxy.clientapi.core.ClientApi
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
Params - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Params(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Params
pause(String) - Method in class org.zaproxy.clientapi.gen.Ascan
pause(String) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(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(String, int, String)).
pauseAllScans() - Method in class org.zaproxy.clientapi.gen.Ascan
pauseAllScans() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(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(String, int, String)).
planProgress(String) - Method in class org.zaproxy.clientapi.gen.Automation: This component is optional and therefore the API will only work if it is installed
pnh - Variable in class org.zaproxy.clientapi.core.ClientApi
pnh() - Method in class org.zaproxy.clientapi.gen.Pnh: This component is optional and therefore the API will only work if it is installed
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(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
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
pollAsUser(String, String) - Method in class org.zaproxy.clientapi.gen.Users: Tries to poll as the identified user, returning the authentication request and whether it appears to have succeeded.
PostModSecurityAuditEvent(String) - Method in class org.zaproxy.clientapi.gen.ImportLogFiles: Deprecated.

This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
proxyChainExcludedDomains() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
proxypac() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
proxypac() - Method in class org.zaproxy.clientapi.gen.Network: Provides a PAC file, proxying through the main proxy.
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(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) - Method in class org.zaproxy.clientapi.gen.Script: Removes the script with the given name
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(String, int, String)).
removeAdditionalProxy(String, String) - Method in class org.zaproxy.clientapi.gen.LocalProxies: Deprecated.

Removes the additional proxy with the specified address and port.
removeAlertFilter(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AlertFilterDeprecated: Removes an alert filter from the context with the given ID.
removeAlertFilter(String, String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AlertFilterDeprecated: Removes an alert filter from the context with the given ID.
removeAlertFilter(String, String, String, String, String, String, 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.
removeAlertFilter(String, String, String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AlertFilterDeprecated: Removes an alert filter from the context with the given ID.
removeAlias(String) - Method in class org.zaproxy.clientapi.gen.Network: Removes an alias.
removeAllowedResource(String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Removes an allowed resource.
removeAllScans() - Method in class org.zaproxy.clientapi.gen.Ascan
removeAllScans() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(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(String, int, String)).
removeBrowserArgument(String, String) - Method in class org.zaproxy.clientapi.gen.Selenium: Removes a browser argument.
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(String, int, String)).
removeCustomPayload(String, String) - Method in class org.zaproxy.clientapi.gen.Custompayloads: Removes a payload.
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.
removeExcludedElement(String, String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Removes an excluded element from a context.
removeExcludedParam(String) - Method in class org.zaproxy.clientapi.gen.Ascan: Removes a parameter excluded from the scan, with the given index.
removeGlobalAlertFilter(String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AlertFilterDeprecated: Removes a global alert filter.
removeGlobalAlertFilter(String, String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.AlertFilter: Removes a global alert filter.
removeGlobalAlertFilter(String, String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.deprecated.AlertFilterDeprecated: Removes a global alert filter.
removeHttpBreakpoint(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Break: Removes the specified breakpoint
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(String, int, String)).
removeHttpProxyExclusion(String) - Method in class org.zaproxy.clientapi.gen.Network: Removes an HTTP proxy exclusion.
removeLocalServer(String, String) - Method in class org.zaproxy.clientapi.gen.Network: Removes a local server/proxy.
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(String, int, String)).
removePassThrough(String) - Method in class org.zaproxy.clientapi.gen.Network: Removes a pass-through.
removeProxyChainExcludedDomain(String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
removeRateLimitRule(String) - Method in class org.zaproxy.clientapi.gen.Network: Remove a rate limit rule
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) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(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(String, int, String)).
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(String, int, String)).
removeSession(String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Removes the session from the given site.
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(String, int, String)).
removeSessionToken(String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Removes the session token 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(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.
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(String, int, String)).
renameSession(String, String, String) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Renames the session of the given site.
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(String, int, String)).
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
ReplacerDeprecated - Class in org.zaproxy.clientapi.gen.deprecated: API implementation with deprecated methods, (re)moved from generated class.
ReplacerDeprecated(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.deprecated.ReplacerDeprecated
reports - Variable in class org.zaproxy.clientapi.core.ClientApi
Reports - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Reports(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Reports
resetAllRuleConfigValues() - Method in class org.zaproxy.clientapi.gen.RuleConfig: Reset all of the rule configurations
resetRuleConfigValue(String) - Method in class org.zaproxy.clientapi.gen.RuleConfig: Reset the specified rule configuration, which must already exist
results(String) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
results(String, String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Gets the current results of the crawler.
resume(String) - Method in class org.zaproxy.clientapi.gen.Ascan
resume(String) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(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(String, int, String)).
resumeAllScans() - Method in class org.zaproxy.clientapi.gen.Ascan
resumeAllScans() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(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(String, int, String)).
retest - Variable in class org.zaproxy.clientapi.core.ClientApi
retest(String) - Method in class org.zaproxy.clientapi.gen.Retest: This component is optional and therefore the API will only work if it is installed
Retest - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Retest(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Retest
reveal - Variable in class org.zaproxy.clientapi.core.ClientApi
reveal() - Method in class org.zaproxy.clientapi.gen.Reveal: Tells if shows hidden fields and enables disabled fields
Reveal - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Reveal(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Reveal
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
revisit - Variable in class org.zaproxy.clientapi.core.ClientApi
Revisit - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Revisit(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Revisit
revisitList() - Method in class org.zaproxy.clientapi.gen.Revisit: This component is optional and therefore the API will only work if it is installed
revisitSiteOff(String) - Method in class org.zaproxy.clientapi.gen.Revisit: This component is optional and therefore the API will only work if it is installed
revisitSiteOn(String, String, String) - Method in class org.zaproxy.clientapi.gen.Revisit: This component is optional and therefore the API will only work if it is installed
rootCaCert() - Method in class org.zaproxy.clientapi.gen.Network: Gets the Root CA certificate used to issue server certificates.
rootcert() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
ruleConfig - Variable in class org.zaproxy.clientapi.core.ClientApi
RuleConfig - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
RuleConfig(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.RuleConfig
ruleConfigValue(String) - Method in class org.zaproxy.clientapi.gen.RuleConfig: Show the specified rule configuration
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(String, int, String)).
runPlan(String) - Method in class org.zaproxy.clientapi.gen.Automation: This component is optional and therefore the API will only work if it is installed
runStandAloneScript(String) - Method in class org.zaproxy.clientapi.gen.Script: Runs the stand alone script with the given name
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(String, int, String)).

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.
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(String, int, String)).
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(String, int, String)).
scan(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Runs the AJAX Spider against a given target.
scan(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.AccessControl: Starts an Access Control scan with the given context ID and user ID.
scan(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Spider: Runs the spider against the given URL (or context).
scan(String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan
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(String, int, String)).
scan(String, String, String, String, String, String, Integer) - Method in class org.zaproxy.clientapi.gen.Ascan: Runs the active scanner against the given URL or Context.
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(String, int, String)).
scanAsUser(String, String, String, String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Runs the AJAX Spider from the perspective of a User of the web application.
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.
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) - 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(String, int, String)).
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(String, int, String)).
scanners() - Method in class org.zaproxy.clientapi.gen.Pscan: Lists all passive scan rules with their ID, name, enabled state, and alert threshold.
scanners(String, String) - Method in class org.zaproxy.clientapi.gen.Ascan: Gets the scan rules, optionally, of the given scan policy or scanner policy/category ID.
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: This component is optional and therefore the API will only work if it is installed
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
scriptCustomVar(String, String) - Method in class org.zaproxy.clientapi.gen.Script: Gets the value (string representation) of a custom variable.
scriptCustomVars(String) - Method in class org.zaproxy.clientapi.gen.Script: Gets all the custom variables (key/value pairs, the value is the string representation) of a 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: Deprecated.
Use the API endpoints in the 'exim' add-on instead.
sendHarRequest(String, String) - Method in class org.zaproxy.clientapi.gen.Exim: 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(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(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() - Method in class org.zaproxy.clientapi.gen.Pnh: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
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) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Sets the given session as active 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(String, int, String)).
setAlert(String) - Method in class org.zaproxy.clientapi.core.Alert: Deprecated.
(1.1.0) Use Alert.setName(String) instead.
setAliasEnabled(String, String) - Method in class org.zaproxy.clientapi.gen.Network: Sets whether or not an alias is enabled.
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.
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(String, int, String)).
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(String, int, String)).
setAuthenticationState(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Users: Sets fields in the authentication state for the user identified by the Context and User Ids.
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(String, int, String)).
setBreakTextMessage(String, String) - Method in class org.zaproxy.clientapi.gen.Websocket: Sets the text message for an intercepted websockets message
setBrowserArgumentEnabled(String, String, String) - Method in class org.zaproxy.clientapi.gen.Selenium: Sets whether or not a browser argument is enabled.
setConfidence(String) - Method in class org.zaproxy.clientapi.core.Alert
setConfidence(Alert.Confidence) - Method in class org.zaproxy.clientapi.core.Alert
setConnectionTimeout(String) - Method in class org.zaproxy.clientapi.gen.Network: Sets the timeout, for reads and connects.
setContextCheckingStrategy(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Context: Set the checking strategy for a context - this defines how ZAP checks that a request is authenticated
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(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
setCookie(String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Users: Sets the specified cookie for the user identified by the Context and User Ids.
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.
setDefaultUserAgent(String) - Method in class org.zaproxy.clientapi.gen.Network: Sets the default user-agent.
setDnsTtlSuccessfulQueries(String) - Method in class org.zaproxy.clientapi.gen.Network: Sets the TTL of successful DNS queries.
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.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(String, int, String)).
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
setEnabledAllowedResource(String, String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Sets whether or not an allowed resource is enabled.
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(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)
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(String, int, String)).
setForcedUserModeEnabled(boolean) - Method in class org.zaproxy.clientapi.gen.ForcedUser: Sets if 'forced user' mode should be enabled or not
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(String, int, String)).
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(String, int, String)).
setHttpMessage(String, String) - Method in class org.zaproxy.clientapi.gen.Break: Overwrites the currently intercepted message with the data provided
setHttpProxy(String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Network: Sets the HTTP proxy configuration.
setHttpProxyAuthEnabled(String) - Method in class org.zaproxy.clientapi.gen.Network: Sets whether or not the HTTP proxy authentication is enabled.
setHttpProxyEnabled(String) - Method in class org.zaproxy.clientapi.gen.Network: Sets whether or not the HTTP proxy is enabled.
setHttpProxyExclusionEnabled(String, String) - Method in class org.zaproxy.clientapi.gen.Network: Sets whether or not an HTTP proxy exclusion is enabled.
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(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(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(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(String, int, String)).
setOptionArgsType(String) - Method in class org.zaproxy.clientapi.gen.Graphql: Sets how arguments are specified.
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(String, int, String)).
setOptionBrowserId(String) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Sets the configuration of the AJAX Spider to use one of the supported browsers.
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(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(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(String, int, String)).
setOptionChromeBinaryPath(String) - Method in class org.zaproxy.clientapi.gen.Selenium: Sets the current path to Chrome binary
setOptionChromeDriverPath(String) - Method in class org.zaproxy.clientapi.gen.Selenium: Sets the current path to ChromeDriver
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(String, int, String)).
setOptionClickDefaultElems(boolean) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Sets whether or not the the AJAX Spider will only click on the default HTML elements.
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(String, int, String)).
setOptionClickElemsOnce(boolean) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: When enabled, the crawler attempts to interact with each element (e.g., by clicking) only once.
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(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(String, int, String)).
setOptionDefaultUserAgent(String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
setOptionDelayInMs(int) - Method in class org.zaproxy.clientapi.gen.Ascan: Deprecated.
Option no longer in effective use.
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(String, int, String)).
setOptionDnsTtlSuccessfulQueries(int) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
setOptionEventWait(int) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Sets the time to wait after an event (in milliseconds).
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(String, int, String)).
setOptionFirefoxBinaryPath(String) - Method in class org.zaproxy.clientapi.gen.Selenium: Sets the current path to Firefox binary
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(String, int, String)).
setOptionFirefoxDefaultProfile(String) - Method in class org.zaproxy.clientapi.gen.Selenium: This component is optional and therefore the API will only work if it is installed
setOptionFirefoxDriverPath(String) - Method in class org.zaproxy.clientapi.gen.Selenium: Sets the current path to Firefox driver (geckodriver)
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(String, int, String)).
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(String, int, String)).
setOptionHandleODataParametersVisited(boolean) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
setOptionHandleParameters(String) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
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(String, int, String)).
setOptionHttpStateEnabled(boolean) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
setOptionIeDriverPath(String) - Method in class org.zaproxy.clientapi.gen.Selenium: Deprecated.
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(String, int, String)).
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 scan rule 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(String, int, String)).
setOptionInMemoryEnabled(boolean) - Method in class org.zaproxy.clientapi.gen.Stats: Sets whether in memory statistics are enabled
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(String, int, String)).
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(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(String, int, String)).
setOptionLastDirectory(String) - Method in class org.zaproxy.clientapi.gen.Selenium: This component is optional and therefore the API will only work if it is installed
setOptionLenientMaxQueryDepthEnabled(boolean) - Method in class org.zaproxy.clientapi.gen.Graphql: Sets whether or not Maximum Query Depth is enforced leniently.
setOptionMaxAdditionalQueryDepth(int) - Method in class org.zaproxy.clientapi.gen.Graphql: Sets the maximum additional query generation depth (used if enforced leniently).
setOptionMaxAlertsPerRule(int) - Method in class org.zaproxy.clientapi.gen.Ascan: Sets the maximum number of alerts that a rule can raise before being skipped.
setOptionMaxArgsDepth(int) - Method in class org.zaproxy.clientapi.gen.Graphql: Sets the maximum arguments generation depth.
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(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: Sets the maximum depth that the crawler can reach.
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(String, int, String)).
setOptionMaxCrawlStates(int) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Sets the maximum number of states that the crawler should crawl.
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(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.
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(String, int, String)).
setOptionMaxDuration(int) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: The maximum time that the crawler is allowed to run.
setOptionMaxDuration(int) - Method in class org.zaproxy.clientapi.gen.Spider: 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(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(String, int, String)).
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.
setOptionMaxQueryDepth(int) - Method in class org.zaproxy.clientapi.gen.Graphql: Sets the maximum query generation depth.
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(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(int) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(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(String, int, String)).
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: Sets the number of windows to be used by AJAX Spider.
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(String, int, String)).
setOptionOptionalArgsEnabled(boolean) - Method in class org.zaproxy.clientapi.gen.Graphql: Sets whether or not Optional Arguments should be specified.
setOptionParseComments(boolean) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
setOptionParseDsStore(boolean) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
setOptionParseGit(boolean) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
setOptionParseRobotsTxt(boolean) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
setOptionParseSitemapXml(boolean) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
setOptionParseSVNEntries(boolean) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
setOptionPartialMatchingEnabled(boolean) - Method in class org.zaproxy.clientapi.gen.Acsrf: Define if ZAP should detect CSRF tokens by searching for partial matches.
setOptionPhantomJsBinaryPath(String) - Method in class org.zaproxy.clientapi.gen.Selenium: Deprecated.
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(String, int, String)).
setOptionPostForm(boolean) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
setOptionProcessForm(boolean) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
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(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(String, int, String)).
setOptionProxyChainName(String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
setOptionProxyChainPassword(String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
setOptionProxyChainPort(int) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
setOptionProxyChainPrompt(boolean) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
setOptionProxyChainRealm(String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(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(String, int, String)).
setOptionProxyChainUserName(String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
setOptionQueryGenEnabled(boolean) - Method in class org.zaproxy.clientapi.gen.Graphql: Sets whether the query generator is enabled.
setOptionQuerySplitType(String) - Method in class org.zaproxy.clientapi.gen.Graphql: Sets the level for which a single query is generated.
setOptionRandomInputs(boolean) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: When enabled, inserts random values into form fields.
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(String, int, String)).
setOptionReloadWait(int) - Method in class org.zaproxy.clientapi.gen.AjaxSpider: Sets the time to wait after the page is loaded before interacting with it.
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(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(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(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(String, int, String)).
setOptionRequestMethod(String) - Method in class org.zaproxy.clientapi.gen.Graphql: Sets the request method.
setOptionRequestWaitTime(int) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
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(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(String, int, String)).
setOptionScanNullJsonValues(boolean) - Method in class org.zaproxy.clientapi.gen.Ascan: Sets whether or not the active scanner should scan null JSON values.
setOptionScopeString(String) - Method in class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated: Deprecated.
Option no longer in effective use.
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(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.
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(String, int, String)).
setOptionShowAdvancedDialog(boolean) - Method in class org.zaproxy.clientapi.gen.Ascan
setOptionShowAdvancedDialog(boolean) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(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(String, int, String)).
setOptionSingleCookieRequestHeader(boolean) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Option no longer in effective use.
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(String, int, String)).
setOptionSkipURLString(String) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(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
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(String, int, String)).
setOptionStatsdPort(int) - Method in class org.zaproxy.clientapi.gen.Stats: Sets the Statsd service port
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(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
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(String, int, String)).
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(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(String, int, String)).
setOptionThreadCount(int) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
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(String, int, String)).
setOptionTimeoutInSecs(int) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
setOptionUseProxyChain(boolean) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
setOptionUseProxyChainAuth(boolean) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
setOptionUserAgent(String) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
setOptionUseSocksProxy(boolean) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
setOther(String) - Method in class org.zaproxy.clientapi.core.Alert
setParam(String) - Method in class org.zaproxy.clientapi.core.Alert
setPassThroughEnabled(String, String) - Method in class org.zaproxy.clientapi.gen.Network: Sets whether or not a pass-through is enabled.
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(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(String, int, String)).
setproxy(String) - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the API endpoints in the 'network' component instead.
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(String, int, String)).
setProxy(String) - Method in class org.zaproxy.clientapi.gen.Network: Sets the HTTP proxy configuration.
setRateLimitRuleEnabled(String, String) - Method in class org.zaproxy.clientapi.gen.Network: Set enabled state for a rate limit rule.
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
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
setReveal(String) - Method in class org.zaproxy.clientapi.gen.Reveal: Sets if shows hidden fields and enables disabled fields
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(String, int, String)).
setRisk(String) - Method in class org.zaproxy.clientapi.core.Alert
setRisk(Alert.Risk) - Method in class org.zaproxy.clientapi.core.Alert
setRootCaCertValidity(String) - Method in class org.zaproxy.clientapi.gen.Network: Sets the Root CA certificate validity.
setRuleConfigValue(String, String) - Method in class org.zaproxy.clientapi.gen.RuleConfig: Set the specified rule configuration, which must already exist
setScannerAlertThreshold(String, String) - Method in class org.zaproxy.clientapi.gen.Pscan: Sets the alert threshold of the passive scan rule with the given ID, accepted values for alert threshold: OFF, DEFAULT, LOW, MEDIUM and HIGH
setScannerAlertThreshold(String, String, String) - Method in class org.zaproxy.clientapi.gen.Ascan
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(String, int, String)).
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(String, int, String)).
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(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.
setServerCertValidity(String) - Method in class org.zaproxy.clientapi.gen.Network: Sets the server certificate validity.
setSessionManagementMethod(String, String, String) - Method in class org.zaproxy.clientapi.gen.SessionManagement: Sets the session management method for the context with the given ID.
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(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.
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(String, int, String)).
setSocksProxy(String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Network: Sets the SOCKS proxy configuration.
setSocksProxyEnabled(String) - Method in class org.zaproxy.clientapi.gen.Network: Sets whether or not the SOCKS proxy is enabled.
setUrl(String) - Method in class org.zaproxy.clientapi.core.Alert
setUseClientCertificate(String) - Method in class org.zaproxy.clientapi.gen.Network: Sets whether or not to use the active client certificate.
setUseGlobalHttpState(String) - Method in class org.zaproxy.clientapi.gen.Network: Sets whether or not to use the global HTTP state.
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.
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(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.
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(String, int, String)).
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(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 scan rule using the given IDs of the scan and the scan rule.
snapshotSession() - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated
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(String, int, String)).
snapshotSession(String, String) - Method in class org.zaproxy.clientapi.gen.Core: Snapshots the session, optionally with the given name, and overwriting existing files.
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) - Method in class org.zaproxy.clientapi.gen.Pnh: This component is optional and therefore the API will only work if it is installed
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(String, int, String)).
stats - Variable in class org.zaproxy.clientapi.core.ClientApi
stats(String) - Method in class org.zaproxy.clientapi.gen.Stats: Statistics
Stats - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Stats(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Stats
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: Gets the current status of the crawler.
status(String) - Method in class org.zaproxy.clientapi.gen.Ascan
status(String) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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: Stops the AJAX Spider.
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(String, int, String)).
stop(String) - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(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(String, int, String)).
stopAllScans() - Method in class org.zaproxy.clientapi.gen.Ascan
stopAllScans() - Method in class org.zaproxy.clientapi.gen.Spider: This component is optional and therefore the API will only work if it is installed
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(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(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
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(String, int, String)).
Suspicious - org.zaproxy.clientapi.core.Alert.Reliability: Deprecated.

T

technologyList() - Method in class org.zaproxy.clientapi.gen.Context: Lists the names of all built in technologies
templateDetails(String) - Method in class org.zaproxy.clientapi.gen.Reports: View details of the specified template.
templates() - Method in class org.zaproxy.clientapi.gen.Reports: View available templates.
testAll() - Method in class org.zaproxy.clientapi.gen.AlertFilter: Tests all currently enabled Global and Context alert filters.
testContext() - Method in class org.zaproxy.clientapi.gen.AlertFilter: Tests all currently enabled Context alert filters.
testGlobal() - Method in class org.zaproxy.clientapi.gen.AlertFilter: Tests all currently enabled Global alert filters.
toString() - Method in class org.zaproxy.clientapi.core.Alert
toString() - Method in class org.zaproxy.clientapi.core.ApiResponseElement
toString(int) - Method in class org.zaproxy.clientapi.core.ApiResponse
toString(int) - 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) - Method in class org.zaproxy.clientapi.gen.HttpSessions: Unsets the active session of the given site.
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(String, int, String)).
updateAlert(String, String, String, String, String, String, String, String, String, String, String, String, String) - Method in class org.zaproxy.clientapi.gen.Alert: Update the alert with the given ID, with the provided details.
updateAlertsConfidence(String, String) - Method in class org.zaproxy.clientapi.gen.Alert: Update the confidence of the alerts.
updateAlertsRisk(String, String) - Method in class org.zaproxy.clientapi.gen.Alert: Update the risk of the alerts.
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() - Method in class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated: Gets the URLs accessed through/by ZAP
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.
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.
wappalyzer - Variable in class org.zaproxy.clientapi.core.ClientApi
Wappalyzer - Class in org.zaproxy.clientapi.gen: This file was automatically generated.
Wappalyzer(ClientApi) - Constructor for class org.zaproxy.clientapi.gen.Wappalyzer
Warning - org.zaproxy.clientapi.core.Alert.Reliability: Deprecated.
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
writeHTMLreport(String, String) - Method in class org.zaproxy.clientapi.gen.AccessControl: Generates an Access Control report for the given context ID and saves it based on the provided filename (path).

X

xmlreport() - Method in class org.zaproxy.clientapi.gen.Core: Deprecated.
Use the 'generate' API endpoint the 'reports' component instead.
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(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
All Classes All Packages