Package org.zaproxy.clientapi.gen

Class Oast

java.lang.Object

org.zaproxy.clientapi.gen.Oast

public class Oast
extends java.lang.Object

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Oast(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	getActiveScanService()	Gets the service used with the active scanner, if any.
ApiResponse	getBoastOptions()	Gets the BOAST options.
ApiResponse	getCallbackOptions()	Gets the Callback options.
ApiResponse	getDaysToKeepRecords()	Gets the number of days the OAST records will be kept for.
ApiResponse	getInteractshOptions()	Gets the Interactsh options.
ApiResponse	getServices()	Gets all of the services.
ApiResponse	setActiveScanService(java.lang.String name)	Sets the service used with the active scanner.
ApiResponse	setBoastOptions(java.lang.String server, java.lang.String pollinsecs)	Sets the BOAST options.
ApiResponse	setCallbackOptions(java.lang.String localaddress, java.lang.String remoteaddress, java.lang.String port)	Sets the Callback options.
ApiResponse	setDaysToKeepRecords(java.lang.String days)	Sets the number of days the OAST records will be kept for.
ApiResponse	setInteractshOptions(java.lang.String server, java.lang.String pollinsecs, java.lang.String authtoken)	Sets the Interactsh options.

Methods inherited from class java.lang.Object

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

Constructor Detail

Oast

public Oast(ClientApi api)

Method Detail

getActiveScanService

public ApiResponse getActiveScanService()
                                 throws ClientApiException

Gets the service used with the active scanner, if any.

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

Throws:

ClientApiException

getServices

public ApiResponse getServices()
                        throws ClientApiException

Gets all of the services.

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

Throws:

ClientApiException

getBoastOptions

public ApiResponse getBoastOptions()
                            throws ClientApiException

Gets the BOAST options.

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

Throws:

ClientApiException

getCallbackOptions

public ApiResponse getCallbackOptions()
                               throws ClientApiException

Gets the Callback options.

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

Throws:

ClientApiException

getInteractshOptions

public ApiResponse getInteractshOptions()
                                 throws ClientApiException

Gets the Interactsh options.

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

Throws:

ClientApiException

getDaysToKeepRecords

public ApiResponse getDaysToKeepRecords()
                                 throws ClientApiException

Gets the number of days the OAST records will be kept for.

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

Throws:

ClientApiException

setActiveScanService

public ApiResponse setActiveScanService(java.lang.String name)
                                 throws ClientApiException

Sets the service used with the active scanner.

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

Throws:

ClientApiException

setBoastOptions

public ApiResponse setBoastOptions(java.lang.String server,
                                   java.lang.String pollinsecs)
                            throws ClientApiException

Sets the BOAST options.

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

Throws:

ClientApiException

setCallbackOptions

public ApiResponse setCallbackOptions(java.lang.String localaddress,
                                      java.lang.String remoteaddress,
                                      java.lang.String port)
                               throws ClientApiException

Sets the Callback options.

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

Throws:

ClientApiException

setInteractshOptions

public ApiResponse setInteractshOptions(java.lang.String server,
                                        java.lang.String pollinsecs,
                                        java.lang.String authtoken)
                                 throws ClientApiException

Sets the Interactsh options.

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

Throws:

ClientApiException

setDaysToKeepRecords

public ApiResponse setDaysToKeepRecords(java.lang.String days)
                                 throws ClientApiException

Sets the number of days the OAST records will be kept for.

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

Throws:

ClientApiException