ZAP API UI

Component: break

Views

httpMessage	Returns the HTTP message currently intercepted (if any)
isBreakAll	Returns True if ZAP will break on both requests and responses
isBreakRequest	Returns True if ZAP will break on requests
isBreakResponse	Returns True if ZAP will break on responses

Actions

addHttpBreakpoint (string* location* match* inverse* ignorecase* )	Adds a custom HTTP breakpoint. The string is the string to match. Location may be one of: url, request_header, request_body, response_header or response_body. Match may be: contains or regex. Inverse (match) may be true or false. Lastly, ignorecase (when matching the string) may be true or false.
break (type* state* scope )	Controls the global break functionality. The type may be one of: http-all, http-request or http-response. The state may be true (for turning break on for the specified type) or false (for turning break off). Scope is not currently used.
continue	Submits the currently intercepted message and unsets the global request/response breakpoints
drop	Drops the currently intercepted message
removeHttpBreakpoint (string* location* match* inverse* ignorecase* )	Removes the specified breakpoint
setHttpMessage (httpHeader* httpBody )	Overwrites the currently intercepted message with the data provided
step	Submits the currently intercepted message, the next request or response will automatically be intercepted

Persistent Connections

waitForHttpBreak (poll keepalive )

Waits until an HTTP breakpoint has been hit, at which point it returns the message. Poll is the number of milliseconds ZAP will pause between checking for breakpoints being hit (default 500). If keepalive is zero or less then the response will be returned as a Server Sent Event, otherwise it is used as the frequency in seconds at which 'keepalive' events should be returned and the response is sent as a standard response.