---
title: "Create a AiSanitizer plugin"
method: POST
path: "/{workspace}/plugins#AiSanitizer"
tags: ["Plugins"]
---

# Create a AiSanitizer plugin

`POST /{workspace}/plugins#AiSanitizer`

Create a AiSanitizer plugin

## Request body

- AiSanitizerPlugin — A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.
  - `condition` string, nullable — An expression used for conditional control over plugin execution. If the expression evaluates to `true` during the request flow, the plugin is executed; otherwise, it is skipped.
  - `created_at` integer, nullable — Unix epoch when the resource was created.
  - `enabled` boolean, nullable — Whether the plugin is applied.
  - `id` string, nullable — A string representing a UUID (universally unique identifier).
  - `instance_name` string, nullable — A unique string representing a UTF-8 encoded name.
  - `name` 'ai-sanitizer', required — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object, nullable
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `partials` object[] — A list of partials to be used by the plugin.
    - `id` string — A string representing a UUID (universally unique identifier).
    - `name` string — A unique string representing a UTF-8 encoded name.
    - `path` string
  - `tags` string[], nullable — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
  - `config` object
    - `allow_all_conversation_history` boolean — If false, will ignore all previous chat messages from the conversation history.
    - `anonymize` string[] — List of types to be anonymized
    - `block_if_detected` boolean — Whether to block requests containing PII data
    - `custom_patterns` object[] — List of custom patterns to be used for anonymization
      - `name` string, required
      - `regex` string, required
      - `score` number
    - `host` string — The host of the sanitizer
    - `keepalive_timeout` number — The keepalive timeout for the established http connnection
    - `port` number — The port of the sanitizer
    - `recover_redacted` boolean — Whether to recover redacted data. This doesn't apply to the redacted output.
    - `redact_type` 'placeholder' | 'synthetic' — What value to be used to redacted to
    - `sanitization_mode` 'BOTH' | 'INPUT' | 'OUTPUT' — The sanitization mode to use for the request
    - `scheme` string — The protocol can be http and https
    - `skip_logging_sanitized_items` boolean — Whether to log sanitized items in the Kong log plugins. Turn it on if you want to hide sensitive data from logs.
    - `stop_on_error` boolean — Stop processing if an error occurs.
    - `timeout` number — Connection timeout with the sanitizer
  - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    - `id` string
  - `consumer_group` object — If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    - `id` string
  - `protocols` string[] — A set of strings representing HTTP protocols.
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Response `201`

Created AiSanitizer plugin

- AiSanitizerPlugin — A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.
  - `condition` string, nullable — An expression used for conditional control over plugin execution. If the expression evaluates to `true` during the request flow, the plugin is executed; otherwise, it is skipped.
  - `created_at` integer, nullable — Unix epoch when the resource was created.
  - `enabled` boolean, nullable — Whether the plugin is applied.
  - `id` string, nullable — A string representing a UUID (universally unique identifier).
  - `instance_name` string, nullable — A unique string representing a UTF-8 encoded name.
  - `name` 'ai-sanitizer', required — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object, nullable
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `partials` object[] — A list of partials to be used by the plugin.
    - `id` string — A string representing a UUID (universally unique identifier).
    - `name` string — A unique string representing a UTF-8 encoded name.
    - `path` string
  - `tags` string[], nullable — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
  - `config` object
    - `allow_all_conversation_history` boolean — If false, will ignore all previous chat messages from the conversation history.
    - `anonymize` string[] — List of types to be anonymized
    - `block_if_detected` boolean — Whether to block requests containing PII data
    - `custom_patterns` object[] — List of custom patterns to be used for anonymization
      - `name` string, required
      - `regex` string, required
      - `score` number
    - `host` string — The host of the sanitizer
    - `keepalive_timeout` number — The keepalive timeout for the established http connnection
    - `port` number — The port of the sanitizer
    - `recover_redacted` boolean — Whether to recover redacted data. This doesn't apply to the redacted output.
    - `redact_type` 'placeholder' | 'synthetic' — What value to be used to redacted to
    - `sanitization_mode` 'BOTH' | 'INPUT' | 'OUTPUT' — The sanitization mode to use for the request
    - `scheme` string — The protocol can be http and https
    - `skip_logging_sanitized_items` boolean — Whether to log sanitized items in the Kong log plugins. Turn it on if you want to hide sensitive data from logs.
    - `stop_on_error` boolean — Stop processing if an error occurs.
    - `timeout` number — Connection timeout with the sanitizer
  - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    - `id` string
  - `consumer_group` object — If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    - `id` string
  - `protocols` string[] — A set of strings representing HTTP protocols.
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/kong/apis/kong-enterprise-admin-api.md) · [All operations](https://skmtc.net/kong/apis/kong-enterprise-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/kong-enterprise-admin-api/revisions/28b1f8a59cdc/schema)