AI Sanitizer Configuration

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The AI Sanitizer plugin is compatible with the following protocols:

grpc, grpcs, http, https

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name or plugin

  string required

  The name of the plugin, in this case ai-sanitizer.

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example ai-sanitizer_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/{serviceName|Id}/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/{routeName|Id}/plugins.

• consumer.name or consumer.id

  string

  The name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level /plugins endpoint. Not required if using /consumers/{consumerName|Id}/plugins.

• consumer_group.name or consumer_group.id

  string

  The name or ID of the consumer group the plugin targets. If set, the plugin will activate only for requests where the specified group has been authenticated /plugins endpoint. Not required if using /consumer_groups/{consumerGroupName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • host

    string required default: localhost

    The host of the sanitizer

  • port

    number required default: 8080

    The port of the sanitizer

  • scheme

    string required default: http

    The protocol can be http and https

  • timeout

    number default: 10000

    Connection timeout with the sanitizer

  • keepalive_timeout

    number default: 60000

    The keepalive timeout for the established http connnection

  • stop_on_error

    boolean default: true

    Stop processing if an error occurs

  • anonymize

    array of type string required default: all_and_credentials Must be one of: general, phone, email, creditcard, crypto, date, ssn, ip, nrp, domain, credentials, url, medical, driverlicense, passport, bank, nationalid, custom, all, all_and_credentials

    List of types to be anonymized

  • recover_redacted

    boolean default: true

    Whether to recover redacted data

  • redact_type

    string default: placeholder Must be one of: placeholder, synthetic

    What value to be used to redacted to

  • custom_patterns

    array of type record len_min: 1

    List of custom patterns to be used for anonymization

    • name

      string required

    • regex

      string required

    • score

      number required default: 0.5 between: 0 1