---
title: "PayloadSanitizationConfig"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-dev-3/versions/76e259e8-9e78-4c0e-ab4a-3df25bddc4f1/schemas/PayloadSanitizationConfig"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-dev-3/versions/76e259e8-9e78-4c0e-ab4a-3df25bddc4f1.md

# PayloadSanitizationConfig

Configuration for sanitizing sensitive data in captured payloads

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Konnect Control Planes Configuration
  version: 3.14.0
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
components:
  schemas:
    UserDefinedRules:
      description: User-defined payload sanitization rules
      type: object
      properties:
        headers:
          description: Rules for sanitizing HTTP headers
          type: array
          items:
            $ref: "#/components/schemas/HeaderSanitizationRule"
        body:
          description: Rules for sanitizing request/response body content
          type: array
          items:
            $ref: "#/components/schemas/BodySanitizationRule"
    HeaderSanitizationRule:
      type: object
      properties:
        name:
          description: Optional identifier for this rule
          type: string
          example: api-key
        header_name:
          description: HTTP header name to sanitize (case-insensitive)
          type: string
          example: auth-token
        scope:
          $ref: "#/components/schemas/SanitizationScope"
        action:
          $ref: "#/components/schemas/SanitizationAction"
      required:
        - header_name
        - scope
        - action
    BodySanitizationRule:
      type: object
      properties:
        name:
          description: Optional identifier for this rule
          type: string
          example: user-id
        strategy:
          $ref: "#/components/schemas/BodySanitizationStrategy"
        scope:
          $ref: "#/components/schemas/SanitizationScope"
        action:
          $ref: "#/components/schemas/SanitizationAction"
      required:
        - strategy
        - scope
        - action
    SanitizationScope:
      description: Where the rule applies
      type: array
      items:
        type: string
        enum:
          - request
          - response
      default:
        - request
        - response
    SanitizationAction:
      description: |
        - mask: Replace with "******"
      type: string
      default: mask
      enum:
        - mask
    BodySanitizationStrategy:
      description: Strategy for body content sanitization.
      oneOf:
        - $ref: "#/components/schemas/JsonPathStrategy"
        - $ref: "#/components/schemas/RegexStrategy"
    JsonPathStrategy:
      description: Strategy using JSONPath expression to locate content for sanitization.
      type: object
      properties:
        json_path:
          $ref: "#/components/schemas/JsonPathExpression"
      additionalProperties: false
      required:
        - json_path
    RegexStrategy:
      description: Strategy using regex pattern to locate content for sanitization.
      type: object
      properties:
        regex:
          $ref: "#/components/schemas/RegexPattern"
      additionalProperties: false
      required:
        - regex
    JsonPathExpression:
      description: JSONPath expression to locate the value.
      type: string
      example: $.user.email
    RegexPattern:
      description: Regex to match to locate the value.
      type: string
      format: regex
      example: \d{4}-\d{4}-\d{4}-\d{4}
    PayloadSanitizationConfig:
      description: Configuration for sanitizing sensitive data in captured payloads
      type: object
      properties:
        user_defined_rules:
          $ref: "#/components/schemas/UserDefinedRules"
```
