org.zaproxy.clientapi.gen

Class Ascan

java.lang.Object

org.zaproxy.clientapi.gen.Ascan

public class Ascan
extends java.lang.Object

This file was automatically generated.

Constructor Summary

Constructors

Constructor and Description
Ascan(ClientApi api)

Method Summary

Modifier and Type	Method and Description
ApiResponse	addScanPolicy(java.lang.String apikey, java.lang.String scanpolicyname)
ApiResponse	alertsIds(java.lang.String scanid)
ApiResponse	attackModeQueue()
ApiResponse	clearExcludedFromScan(java.lang.String apikey)
ApiResponse	disableAllScanners(java.lang.String apikey, java.lang.String scanpolicyname)
ApiResponse	disableScanners(java.lang.String apikey, java.lang.String ids, java.lang.String scanpolicyname)
ApiResponse	enableAllScanners(java.lang.String apikey, java.lang.String scanpolicyname)
ApiResponse	enableScanners(java.lang.String apikey, java.lang.String ids, java.lang.String scanpolicyname)
ApiResponse	excludedFromScan()
ApiResponse	excludeFromScan(java.lang.String apikey, java.lang.String regex)
ApiResponse	messagesIds(java.lang.String scanid)
ApiResponse	optionAllowAttackOnStart()
ApiResponse	optionAttackPolicy()
ApiResponse	optionDefaultPolicy()
ApiResponse	optionDelayInMs()
ApiResponse	optionExcludedParamList()
ApiResponse	optionHandleAntiCSRFTokens()
ApiResponse	optionHostPerScan()
ApiResponse	optionInjectPluginIdInHeader()
ApiResponse	optionMaxChartTimeInMins()
ApiResponse	optionMaxResultsToList()
ApiResponse	optionMaxScansInUI()
ApiResponse	optionPromptInAttackMode()
ApiResponse	optionPromptToClearFinishedScans()
ApiResponse	optionRescanInAttackMode()
ApiResponse	optionScanHeadersAllRequests() Tells whether or not the HTTP Headers of all requests should be scanned.
ApiResponse	optionShowAdvancedDialog()
ApiResponse	optionTargetParamsEnabledRPC()
ApiResponse	optionTargetParamsInjectable()
ApiResponse	optionThreadPerHost()
ApiResponse	pause(java.lang.String apikey, java.lang.String scanid)
ApiResponse	pauseAllScans(java.lang.String apikey)
ApiResponse	policies(java.lang.String scanpolicyname, java.lang.String policyid)
ApiResponse	removeAllScans(java.lang.String apikey)
ApiResponse	removeScan(java.lang.String apikey, java.lang.String scanid)
ApiResponse	removeScanPolicy(java.lang.String apikey, java.lang.String scanpolicyname)
ApiResponse	resume(java.lang.String apikey, java.lang.String scanid)
ApiResponse	resumeAllScans(java.lang.String apikey)
ApiResponse	scan(java.lang.String apikey, java.lang.String url, java.lang.String recurse, java.lang.String inscopeonly, java.lang.String scanpolicyname, java.lang.String method, java.lang.String postdata)
ApiResponse	scanAsUser(java.lang.String apikey, java.lang.String url, java.lang.String contextid, java.lang.String userid, java.lang.String recurse, java.lang.String scanpolicyname, java.lang.String method, java.lang.String postdata) Active Scans from the perspective of a User, obtained using the given Context ID and User ID.
ApiResponse	scanners(java.lang.String scanpolicyname, java.lang.String policyid)
ApiResponse	scanPolicyNames()
ApiResponse	scanProgress(java.lang.String scanid)
ApiResponse	scans()
ApiResponse	setEnabledPolicies(java.lang.String apikey, java.lang.String ids, java.lang.String scanpolicyname)
ApiResponse	setOptionAllowAttackOnStart(java.lang.String apikey, boolean bool)
ApiResponse	setOptionAttackPolicy(java.lang.String apikey, java.lang.String string)
ApiResponse	setOptionDefaultPolicy(java.lang.String apikey, java.lang.String string)
ApiResponse	setOptionDelayInMs(java.lang.String apikey, int i)
ApiResponse	setOptionHandleAntiCSRFTokens(java.lang.String apikey, boolean bool)
ApiResponse	setOptionHostPerScan(java.lang.String apikey, int i)
ApiResponse	setOptionInjectPluginIdInHeader(java.lang.String apikey, boolean bool)
ApiResponse	setOptionMaxChartTimeInMins(java.lang.String apikey, int i)
ApiResponse	setOptionMaxResultsToList(java.lang.String apikey, int i)
ApiResponse	setOptionMaxScansInUI(java.lang.String apikey, int i)
ApiResponse	setOptionPromptInAttackMode(java.lang.String apikey, boolean bool)
ApiResponse	setOptionPromptToClearFinishedScans(java.lang.String apikey, boolean bool)
ApiResponse	setOptionRescanInAttackMode(java.lang.String apikey, boolean bool)
ApiResponse	setOptionScanHeadersAllRequests(java.lang.String apikey, boolean bool) Sets whether or not the HTTP Headers of all requests should be scanned.
ApiResponse	setOptionShowAdvancedDialog(java.lang.String apikey, boolean bool)
ApiResponse	setOptionTargetParamsEnabledRPC(java.lang.String apikey, int i)
ApiResponse	setOptionTargetParamsInjectable(java.lang.String apikey, int i)
ApiResponse	setOptionThreadPerHost(java.lang.String apikey, int i)
ApiResponse	setPolicyAlertThreshold(java.lang.String apikey, java.lang.String id, java.lang.String alertthreshold, java.lang.String scanpolicyname)
ApiResponse	setPolicyAttackStrength(java.lang.String apikey, java.lang.String id, java.lang.String attackstrength, java.lang.String scanpolicyname)
ApiResponse	setScannerAlertThreshold(java.lang.String apikey, java.lang.String id, java.lang.String alertthreshold, java.lang.String scanpolicyname)
ApiResponse	setScannerAttackStrength(java.lang.String apikey, java.lang.String id, java.lang.String attackstrength, java.lang.String scanpolicyname)
ApiResponse	status(java.lang.String scanid)
ApiResponse	stop(java.lang.String apikey, java.lang.String scanid)
ApiResponse	stopAllScans(java.lang.String apikey)

Methods inherited from class java.lang.Object

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

Constructor Detail

Ascan

public Ascan(ClientApi api)

Method Detail

status

public ApiResponse status(java.lang.String scanid)
                   throws ClientApiException

Throws:

ClientApiException

scanProgress

public ApiResponse scanProgress(java.lang.String scanid)
                         throws ClientApiException

Throws:

ClientApiException

messagesIds

public ApiResponse messagesIds(java.lang.String scanid)
                        throws ClientApiException

Throws:

ClientApiException

alertsIds

public ApiResponse alertsIds(java.lang.String scanid)
                      throws ClientApiException

Throws:

ClientApiException

scans

public ApiResponse scans()
                  throws ClientApiException

Throws:

ClientApiException

scanPolicyNames

public ApiResponse scanPolicyNames()
                            throws ClientApiException

Throws:

ClientApiException

excludedFromScan

public ApiResponse excludedFromScan()
                             throws ClientApiException

Throws:

ClientApiException

scanners

public ApiResponse scanners(java.lang.String scanpolicyname,
                            java.lang.String policyid)
                     throws ClientApiException

Throws:

ClientApiException

policies

public ApiResponse policies(java.lang.String scanpolicyname,
                            java.lang.String policyid)
                     throws ClientApiException

Throws:

ClientApiException

attackModeQueue

public ApiResponse attackModeQueue()
                            throws ClientApiException

Throws:

ClientApiException

optionAttackPolicy

public ApiResponse optionAttackPolicy()
                               throws ClientApiException

Throws:

ClientApiException

optionDefaultPolicy

public ApiResponse optionDefaultPolicy()
                                throws ClientApiException

Throws:

ClientApiException

optionDelayInMs

public ApiResponse optionDelayInMs()
                            throws ClientApiException

Throws:

ClientApiException

optionExcludedParamList

public ApiResponse optionExcludedParamList()
                                    throws ClientApiException

Throws:

ClientApiException

optionHandleAntiCSRFTokens

public ApiResponse optionHandleAntiCSRFTokens()
                                       throws ClientApiException

Throws:

ClientApiException

optionHostPerScan

public ApiResponse optionHostPerScan()
                              throws ClientApiException

Throws:

ClientApiException

optionMaxChartTimeInMins

public ApiResponse optionMaxChartTimeInMins()
                                     throws ClientApiException

Throws:

ClientApiException

optionMaxResultsToList

public ApiResponse optionMaxResultsToList()
                                   throws ClientApiException

Throws:

ClientApiException

optionMaxScansInUI

public ApiResponse optionMaxScansInUI()
                               throws ClientApiException

Throws:

ClientApiException

optionTargetParamsEnabledRPC

public ApiResponse optionTargetParamsEnabledRPC()
                                         throws ClientApiException

Throws:

ClientApiException

optionTargetParamsInjectable

public ApiResponse optionTargetParamsInjectable()
                                         throws ClientApiException

Throws:

ClientApiException

optionThreadPerHost

public ApiResponse optionThreadPerHost()
                                throws ClientApiException

Throws:

ClientApiException

optionAllowAttackOnStart

public ApiResponse optionAllowAttackOnStart()
                                     throws ClientApiException

Throws:

ClientApiException

optionInjectPluginIdInHeader

public ApiResponse optionInjectPluginIdInHeader()
                                         throws ClientApiException

Throws:

ClientApiException

optionPromptInAttackMode

public ApiResponse optionPromptInAttackMode()
                                     throws ClientApiException

Throws:

ClientApiException

optionPromptToClearFinishedScans

public ApiResponse optionPromptToClearFinishedScans()
                                             throws ClientApiException

Throws:

ClientApiException

optionRescanInAttackMode

public ApiResponse optionRescanInAttackMode()
                                     throws ClientApiException

Throws:

ClientApiException

optionScanHeadersAllRequests

public ApiResponse optionScanHeadersAllRequests()
                                         throws ClientApiException

Tells whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.

Throws:

ClientApiException

optionShowAdvancedDialog

public ApiResponse optionShowAdvancedDialog()
                                     throws ClientApiException

Throws:

ClientApiException

scan

public ApiResponse scan(java.lang.String apikey,
                        java.lang.String url,
                        java.lang.String recurse,
                        java.lang.String inscopeonly,
                        java.lang.String scanpolicyname,
                        java.lang.String method,
                        java.lang.String postdata)
                 throws ClientApiException

Throws:

ClientApiException

scanAsUser

public ApiResponse scanAsUser(java.lang.String apikey,
                              java.lang.String url,
                              java.lang.String contextid,
                              java.lang.String userid,
                              java.lang.String recurse,
                              java.lang.String scanpolicyname,
                              java.lang.String method,
                              java.lang.String postdata)
                       throws ClientApiException

Active Scans from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.

Throws:

ClientApiException

pause

public ApiResponse pause(java.lang.String apikey,
                         java.lang.String scanid)
                  throws ClientApiException

Throws:

ClientApiException

resume

public ApiResponse resume(java.lang.String apikey,
                          java.lang.String scanid)
                   throws ClientApiException

Throws:

ClientApiException

stop

public ApiResponse stop(java.lang.String apikey,
                        java.lang.String scanid)
                 throws ClientApiException

Throws:

ClientApiException

removeScan

public ApiResponse removeScan(java.lang.String apikey,
                              java.lang.String scanid)
                       throws ClientApiException

Throws:

ClientApiException

pauseAllScans

public ApiResponse pauseAllScans(java.lang.String apikey)
                          throws ClientApiException

Throws:

ClientApiException

resumeAllScans

public ApiResponse resumeAllScans(java.lang.String apikey)
                           throws ClientApiException

Throws:

ClientApiException

stopAllScans

public ApiResponse stopAllScans(java.lang.String apikey)
                         throws ClientApiException

Throws:

ClientApiException

removeAllScans

public ApiResponse removeAllScans(java.lang.String apikey)
                           throws ClientApiException

Throws:

ClientApiException

clearExcludedFromScan

public ApiResponse clearExcludedFromScan(java.lang.String apikey)
                                  throws ClientApiException

Throws:

ClientApiException

excludeFromScan

public ApiResponse excludeFromScan(java.lang.String apikey,
                                   java.lang.String regex)
                            throws ClientApiException

Throws:

ClientApiException

enableAllScanners

public ApiResponse enableAllScanners(java.lang.String apikey,
                                     java.lang.String scanpolicyname)
                              throws ClientApiException

Throws:

ClientApiException

disableAllScanners

public ApiResponse disableAllScanners(java.lang.String apikey,
                                      java.lang.String scanpolicyname)
                               throws ClientApiException

Throws:

ClientApiException

enableScanners

public ApiResponse enableScanners(java.lang.String apikey,
                                  java.lang.String ids,
                                  java.lang.String scanpolicyname)
                           throws ClientApiException

Throws:

ClientApiException

disableScanners

public ApiResponse disableScanners(java.lang.String apikey,
                                   java.lang.String ids,
                                   java.lang.String scanpolicyname)
                            throws ClientApiException

Throws:

ClientApiException

setEnabledPolicies

public ApiResponse setEnabledPolicies(java.lang.String apikey,
                                      java.lang.String ids,
                                      java.lang.String scanpolicyname)
                               throws ClientApiException

Throws:

ClientApiException

setPolicyAttackStrength

public ApiResponse setPolicyAttackStrength(java.lang.String apikey,
                                           java.lang.String id,
                                           java.lang.String attackstrength,
                                           java.lang.String scanpolicyname)
                                    throws ClientApiException

Throws:

ClientApiException

setPolicyAlertThreshold

public ApiResponse setPolicyAlertThreshold(java.lang.String apikey,
                                           java.lang.String id,
                                           java.lang.String alertthreshold,
                                           java.lang.String scanpolicyname)
                                    throws ClientApiException

Throws:

ClientApiException

setScannerAttackStrength

public ApiResponse setScannerAttackStrength(java.lang.String apikey,
                                            java.lang.String id,
                                            java.lang.String attackstrength,
                                            java.lang.String scanpolicyname)
                                     throws ClientApiException

Throws:

ClientApiException

setScannerAlertThreshold

public ApiResponse setScannerAlertThreshold(java.lang.String apikey,
                                            java.lang.String id,
                                            java.lang.String alertthreshold,
                                            java.lang.String scanpolicyname)
                                     throws ClientApiException

Throws:

ClientApiException

addScanPolicy

public ApiResponse addScanPolicy(java.lang.String apikey,
                                 java.lang.String scanpolicyname)
                          throws ClientApiException

Throws:

ClientApiException

removeScanPolicy

public ApiResponse removeScanPolicy(java.lang.String apikey,
                                    java.lang.String scanpolicyname)
                             throws ClientApiException

Throws:

ClientApiException

setOptionAttackPolicy

public ApiResponse setOptionAttackPolicy(java.lang.String apikey,
                                         java.lang.String string)
                                  throws ClientApiException

Throws:

ClientApiException

setOptionDefaultPolicy

public ApiResponse setOptionDefaultPolicy(java.lang.String apikey,
                                          java.lang.String string)
                                   throws ClientApiException

Throws:

ClientApiException

setOptionAllowAttackOnStart

public ApiResponse setOptionAllowAttackOnStart(java.lang.String apikey,
                                               boolean bool)
                                        throws ClientApiException

Throws:

ClientApiException

setOptionDelayInMs

public ApiResponse setOptionDelayInMs(java.lang.String apikey,
                                      int i)
                               throws ClientApiException

Throws:

ClientApiException

setOptionHandleAntiCSRFTokens

public ApiResponse setOptionHandleAntiCSRFTokens(java.lang.String apikey,
                                                 boolean bool)
                                          throws ClientApiException

Throws:

ClientApiException

setOptionHostPerScan

public ApiResponse setOptionHostPerScan(java.lang.String apikey,
                                        int i)
                                 throws ClientApiException

Throws:

ClientApiException

setOptionInjectPluginIdInHeader

public ApiResponse setOptionInjectPluginIdInHeader(java.lang.String apikey,
                                                   boolean bool)
                                            throws ClientApiException

Throws:

ClientApiException

setOptionMaxChartTimeInMins

public ApiResponse setOptionMaxChartTimeInMins(java.lang.String apikey,
                                               int i)
                                        throws ClientApiException

Throws:

ClientApiException

setOptionMaxResultsToList

public ApiResponse setOptionMaxResultsToList(java.lang.String apikey,
                                             int i)
                                      throws ClientApiException

Throws:

ClientApiException

setOptionMaxScansInUI

public ApiResponse setOptionMaxScansInUI(java.lang.String apikey,
                                         int i)
                                  throws ClientApiException

Throws:

ClientApiException

setOptionPromptInAttackMode

public ApiResponse setOptionPromptInAttackMode(java.lang.String apikey,
                                               boolean bool)
                                        throws ClientApiException

Throws:

ClientApiException

setOptionPromptToClearFinishedScans

public ApiResponse setOptionPromptToClearFinishedScans(java.lang.String apikey,
                                                       boolean bool)
                                                throws ClientApiException

Throws:

ClientApiException

setOptionRescanInAttackMode

public ApiResponse setOptionRescanInAttackMode(java.lang.String apikey,
                                               boolean bool)
                                        throws ClientApiException

Throws:

ClientApiException

setOptionScanHeadersAllRequests

public ApiResponse setOptionScanHeadersAllRequests(java.lang.String apikey,
                                                   boolean bool)
                                            throws ClientApiException

Sets whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.

Throws:

ClientApiException

setOptionShowAdvancedDialog

public ApiResponse setOptionShowAdvancedDialog(java.lang.String apikey,
                                               boolean bool)
                                        throws ClientApiException

Throws:

ClientApiException

setOptionTargetParamsEnabledRPC

public ApiResponse setOptionTargetParamsEnabledRPC(java.lang.String apikey,
                                                   int i)
                                            throws ClientApiException

Throws:

ClientApiException

setOptionTargetParamsInjectable

public ApiResponse setOptionTargetParamsInjectable(java.lang.String apikey,
                                                   int i)
                                            throws ClientApiException

Throws:

ClientApiException

setOptionThreadPerHost

public ApiResponse setOptionThreadPerHost(java.lang.String apikey,
                                          int i)
                                   throws ClientApiException

Throws:

ClientApiException