Package org.zaproxy.clientapi.gen

Class Custompayloads

java.lang.Object

org.zaproxy.clientapi.gen.Custompayloads

public class Custompayloads
extends java.lang.Object

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Custompayloads(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	addCustomPayload(java.lang.String category, java.lang.String payload)	Adds a new payload.
ApiResponse	customPayloads(java.lang.String category)	Lists all the payloads currently loaded (category, payload, enabled state).
ApiResponse	customPayloadsCategories()	Lists all available categories.
ApiResponse	disableCustomPayload(java.lang.String category, java.lang.String payload)	Disables a given payload.
ApiResponse	disableCustomPayloads(java.lang.String category)	Disables payloads for a given category.
ApiResponse	enableCustomPayload(java.lang.String category, java.lang.String payload)	Enables a given payload.
ApiResponse	enableCustomPayloads(java.lang.String category)	Enables payloads for a given category.
ApiResponse	removeCustomPayload(java.lang.String category, java.lang.String payload)	Removes a payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

Custompayloads

public Custompayloads(ClientApi api)

Method Detail

customPayloadsCategories

public ApiResponse customPayloadsCategories()
                                     throws ClientApiException

Lists all available categories.

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

Throws:

ClientApiException

customPayloads

public ApiResponse customPayloads(java.lang.String category)
                           throws ClientApiException

Lists all the payloads currently loaded (category, payload, enabled state). Optionally filtered by category.

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

Throws:

ClientApiException

disableCustomPayloads

public ApiResponse disableCustomPayloads(java.lang.String category)
                                  throws ClientApiException

Disables payloads for a given category.

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

Throws:

ClientApiException

enableCustomPayloads

public ApiResponse enableCustomPayloads(java.lang.String category)
                                 throws ClientApiException

Enables payloads for a given category.

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

Throws:

ClientApiException

removeCustomPayload

public ApiResponse removeCustomPayload(java.lang.String category,
                                       java.lang.String payload)
                                throws ClientApiException

Removes a payload.

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

Throws:

ClientApiException

addCustomPayload

public ApiResponse addCustomPayload(java.lang.String category,
                                    java.lang.String payload)
                             throws ClientApiException

Adds a new payload.

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

Throws:

ClientApiException

enableCustomPayload

public ApiResponse enableCustomPayload(java.lang.String category,
                                       java.lang.String payload)
                                throws ClientApiException

Enables a given payload.

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

Throws:

ClientApiException

disableCustomPayload

public ApiResponse disableCustomPayload(java.lang.String category,
                                        java.lang.String payload)
                                 throws ClientApiException

Disables a given payload.

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

Throws:

ClientApiException