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

# Create a AiAzureContentSafety plugin

`POST /{workspace}/plugins#AiAzureContentSafety`

Create a AiAzureContentSafety plugin

## Request body

- AiAzureContentSafetyPlugin — 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-azure-content-safety', 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, required
    - `azure_api_version` string — Sets the ?api-version URL parameter, used for defining the Azure Content Services interchange format.
    - `azure_client_id` string — If `azure_use_managed_identity` is true, set the client ID if required.
    - `azure_client_secret` string — If `azure_use_managed_identity` is true, set the client secret if required.
    - `azure_tenant_id` string — If `azure_use_managed_identity` is true, set the tenant ID if required.
    - `azure_use_managed_identity` boolean — If checked, uses (if set) `azure_client_id`, `azure_client_secret`, and/or `azure_tenant_id` for Azure authentication, via Managed or User-assigned identity
    - `blocklist_names` string[] — Use these configured blocklists (in Azure Content Services) when inspecting content.
    - `categories` object[] — Array of categories, and their thresholds, to measure on.
      - `name` string, required
      - `rejection_level` integer, required
    - `content_safety_key` string — If `azure_use_managed_identity` is true, set the API key to call Content Safety.
    - `content_safety_url` string, required — Full URL, inc protocol, of the Azure Content Safety instance.
    - `guarding_mode` 'BOTH' | 'INPUT' | 'OUTPUT' — The guard mode to use for the request
    - `halt_on_blocklist_hit` boolean — Tells Azure to reject the request if any blocklist filter is hit.
    - `log_blocked_content` boolean — Whether to log prompts and responses that are blocked by the guardrail.
    - `output_type` 'EightSeverityLevels' | 'FourSeverityLevels' — See https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/content-filter#content-filtering-categories
    - `response_buffer_size` number — The amount of bytes receiving from upstream to be buffered before sending to the guardrails service. This only applies to the response content guard.
    - `reveal_failure_reason` boolean — Set true to tell the caller why their request was rejected, if so.
    - `ssl_verify` boolean — Whether to verify the certificate presented by the Azure Content Safety service when using HTTPS.
    - `stop_on_error` boolean — Stop processing if an error occurs
    - `text_source` 'concatenate_all_content' | 'concatenate_user_content' — Select where to pick the 'text' for the Azure Content Services request.
  - `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 AiAzureContentSafety plugin

- AiAzureContentSafetyPlugin — 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-azure-content-safety', 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, required
    - `azure_api_version` string — Sets the ?api-version URL parameter, used for defining the Azure Content Services interchange format.
    - `azure_client_id` string — If `azure_use_managed_identity` is true, set the client ID if required.
    - `azure_client_secret` string — If `azure_use_managed_identity` is true, set the client secret if required.
    - `azure_tenant_id` string — If `azure_use_managed_identity` is true, set the tenant ID if required.
    - `azure_use_managed_identity` boolean — If checked, uses (if set) `azure_client_id`, `azure_client_secret`, and/or `azure_tenant_id` for Azure authentication, via Managed or User-assigned identity
    - `blocklist_names` string[] — Use these configured blocklists (in Azure Content Services) when inspecting content.
    - `categories` object[] — Array of categories, and their thresholds, to measure on.
      - `name` string, required
      - `rejection_level` integer, required
    - `content_safety_key` string — If `azure_use_managed_identity` is true, set the API key to call Content Safety.
    - `content_safety_url` string, required — Full URL, inc protocol, of the Azure Content Safety instance.
    - `guarding_mode` 'BOTH' | 'INPUT' | 'OUTPUT' — The guard mode to use for the request
    - `halt_on_blocklist_hit` boolean — Tells Azure to reject the request if any blocklist filter is hit.
    - `log_blocked_content` boolean — Whether to log prompts and responses that are blocked by the guardrail.
    - `output_type` 'EightSeverityLevels' | 'FourSeverityLevels' — See https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/content-filter#content-filtering-categories
    - `response_buffer_size` number — The amount of bytes receiving from upstream to be buffered before sending to the guardrails service. This only applies to the response content guard.
    - `reveal_failure_reason` boolean — Set true to tell the caller why their request was rejected, if so.
    - `ssl_verify` boolean — Whether to verify the certificate presented by the Azure Content Safety service when using HTTPS.
    - `stop_on_error` boolean — Stop processing if an error occurs
    - `text_source` 'concatenate_all_content' | 'concatenate_user_content' — Select where to pick the 'text' for the Azure Content Services request.
  - `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)