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

# Create a AiLakeraGuard plugin

`POST /{workspace}/plugins#AiLakeraGuard`

Create a AiLakeraGuard plugin

## Request body

- AiLakeraGuardPlugin — 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-lakera-guard', 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
    - `api_key` string — API key for the Lakera Guard subscription.
    - `guarding_mode` 'BOTH' | 'INPUT' | 'OUTPUT' — The guardrail mode to use for the request
    - `lakera_service_url` string — The guard-operation URL of the Lakera Guard service. Defaults to the SaaS /v2/guard endpoint. It can be set to a locally hosted instance of Lakera Guard.
    - `log_blocked_content` boolean — Whether to log prompts and responses that are blocked by the guardrail.
    - `project_id` string — Project ID to apply filters from. If null, it will use the subscription's default project.
    - `request_failure_message` string — The message to return when a failure occurs on the request phase.
    - `response_buffer_size` number — The amount of bytes receiving from upstream to be buffered before sending to the Lakera Guard service. This only applies to the response content guard.
    - `response_failure_message` string — The message to return when a failure occurs on the response phase.
    - `reveal_failure_categories` boolean — Whether to reveal failure categories in the response to the caller. They will always be written to the gateway logs, even if set to false.
    - `stop_on_error` boolean — Stop processing if an error occurs.
    - `text_source` 'concatenate_all_content' | 'concatenate_user_content' | 'last_message' — Select where to pick the 'text' for the Lakera Guard request (when text/generation is selected).
    - `timeout` number — Connection timeout with the Lakera Guard service
    - `verify_ssl` boolean — Whether to verify the SSL certificate of the configured Lakera Guard endpoint.
  - `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 AiLakeraGuard plugin

- AiLakeraGuardPlugin — 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-lakera-guard', 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
    - `api_key` string — API key for the Lakera Guard subscription.
    - `guarding_mode` 'BOTH' | 'INPUT' | 'OUTPUT' — The guardrail mode to use for the request
    - `lakera_service_url` string — The guard-operation URL of the Lakera Guard service. Defaults to the SaaS /v2/guard endpoint. It can be set to a locally hosted instance of Lakera Guard.
    - `log_blocked_content` boolean — Whether to log prompts and responses that are blocked by the guardrail.
    - `project_id` string — Project ID to apply filters from. If null, it will use the subscription's default project.
    - `request_failure_message` string — The message to return when a failure occurs on the request phase.
    - `response_buffer_size` number — The amount of bytes receiving from upstream to be buffered before sending to the Lakera Guard service. This only applies to the response content guard.
    - `response_failure_message` string — The message to return when a failure occurs on the response phase.
    - `reveal_failure_categories` boolean — Whether to reveal failure categories in the response to the caller. They will always be written to the gateway logs, even if set to false.
    - `stop_on_error` boolean — Stop processing if an error occurs.
    - `text_source` 'concatenate_all_content' | 'concatenate_user_content' | 'last_message' — Select where to pick the 'text' for the Lakera Guard request (when text/generation is selected).
    - `timeout` number — Connection timeout with the Lakera Guard service
    - `verify_ssl` boolean — Whether to verify the SSL certificate of the configured Lakera Guard endpoint.
  - `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)