HelpAddonsReplacerReplacer

Replacer

The replacer is an easy way to replace strings in requests and responses.

It is accessible via the Options and by default it can be quickly accessed via the ' R' hotkey.

The Replacer Options panel allows you to define as many replacement rules as you need. Each rule is defined by the following fields:

Description

A description that allows you to identify the rule.

Match Type

May be one of:

Request Header (will add if not present)

In this case the 'Match String' will be treated as a header name. If the header is present then its value will be replaced by the replacement text. If the replacement text is empty then the header will be removed (if present). If the header is not present and the replacement text is not empty then the header will be added.

Request Header String

In this case the 'Match String' will be treated as a string or regex expression. If it is present in the request header then it will be replaced by the replacement text.

Request Body String

In this case the 'Match String' will be treated as a string or regex expression. If it is present in the request body then it will be replaced by the replacement text.

Response Header (will add if not present)

In this case the 'Match String' will be treated as a header name. If the header is present then its value will be replaced by the replacement text. If the replacement text is empty then the header will be removed (if present). If the header is not present and the replacement text is not empty then the header will be added.

Response Header String

In this case the 'Match String' will be treated as a string or regex expression. If it is present in the response header then it will be replaced by the replacement text.

Response Body String

In this case the 'Match String' will be treated as a string or regex expression. If it is present in the response body then it will be replaced by the replacement text.

Match String

The string that will be used to identify what should be replaced - see Match Type for details.

Match Regex

If set then the Match String will be treated as a regex expression. This option is disabled when matching actual headers.

Replacement String

The new string that will replace the specified selection.

Enable

If not set then the rule will not apply.

Advanced

If set then an additional tab will be show which allows you to specify which 'initiators' the rule should apply to. Each ZAP component which can send and receive messages is a separate initiator, so this gives you a very fine grain control over exactly when the rule should apply.

If you need even more control over when and how text should be replaced then you can use the ZAP Script Console which gives you complete control over the ZAP messages.