accessControl4

acsrf6

ajaxSpider41

alert13

alertFilter12

ascan90

authentication8

authorization2

automation3

autoupdate32

break11

client5

clientSpider3

context21

core97

custompayloads8

dev1

exim9

forcedUser4

graphql20

httpSessions16

hud37

keyboard2

localProxies3

network48

oast11

openapi2

paramDigger1

params1

pnh8

postman2

pscan17

quickstartlaunch1

replacer4

reports3

retest1

reveal2

revisit3

ruleConfig5

script24

search18

selenium22

sessionManagement4

soap2

spider71

stats13

users15

wappalyzer3

websocket6

custompayloads

GET /JSON/custompayloads/action/addCustomPayload/

Changed on Jul 17, 2026

Adds a new payload.

Request

Base URL
http://zap
Auth
- none
- or API key in header X-ZAP-API-Key
- or API key in query parameter apikey
TypeScript
https://skmtc.dev/zaproxy/apis/zap-api/docs/JSON/custompayloads/action/addCustomPayload/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

Error of JSON endpoints.

codestring required

messagestring required

detailstring

Changes

Jul 17, 2026bbb71f68ed4c Revision changes
- info
  endpoint added
Oct 11, 2019c7cc14d831c3 Revision changes
- breaking
  api path removed without deprecation

Operation history

GET /JSON/custompayloads/action/addCustomPayload/

Request

Response default

Changes

Response