PayloadSanitizationConfig

object

Configuration for sanitizing sensitive data in captured payloads

user_defined_rulesobject

User-defined payload sanitization rules

Show Child Parameters
Example

UserDefinedRules

object

User-defined payload sanitization rules

headersarray[object]

Rules for sanitizing HTTP headers

Show Child Parameters
bodyarray[object]

Rules for sanitizing request/response body content

Show Child Parameters
Example

HeaderSanitizationRule

object
namestring

Optional identifier for this rule

Example:api-key

header_namestringrequired

HTTP header name to sanitize (case-insensitive)

Example:auth-token

scopearray[string]required

Where the rule applies

Allowed values:requestresponse

Default:request, response

actionstringrequired
  • mask: Replace with “******”

Allowed values:mask

Default:mask

Example

BodySanitizationRule

object
namestring

Optional identifier for this rule

Example:user-id

strategyOne Of
required

Strategy for body content sanitization.

JsonPathStrategyobject

Strategy using JSONPath expression to locate content for sanitization.

* Additional properties are NOT allowed.
Show Child Parameters
scopearray[string]required

Where the rule applies

Allowed values:requestresponse

Default:request, response

actionstringrequired
  • mask: Replace with “******”

Allowed values:mask

Default:mask

Example

SanitizationScope

array

Where the rule applies

Default:request, response