--- title: "Create a XmlThreatProtection plugin" method: POST path: "/{workspace}/plugins#XmlThreatProtection" tags: ["Plugins"] --- # Create a XmlThreatProtection plugin `POST /{workspace}/plugins#XmlThreatProtection` Create a XmlThreatProtection plugin ## Request body - XmlThreatProtectionPlugin — 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` 'xml-threat-protection', 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_dtd` boolean — Indicates whether an XML Document Type Definition (DTD) section is allowed. - `allowed_content_types` string[] — A list of Content-Type values with payloads that are allowed, but aren't validated. - `attribute` integer — Maximum size of the attribute value. - `bla_max_amplification` number — Sets the maximum allowed amplification. This protects against the Billion Laughs Attack. - `bla_threshold` integer — Sets the threshold after which the protection starts. This protects against the Billion Laughs Attack. - `buffer` integer — Maximum size of the unparsed buffer (see below). - `checked_content_types` string[] — A list of Content-Type values with payloads that must be validated. - `comment` integer — Maximum size of comments. - `document` integer — Maximum size of the entire document. - `entity` integer — Maximum size of entity values in EntityDecl. - `entityname` integer — Maximum size of entity names in EntityDecl. - `entityproperty` integer — Maximum size of systemId, publicId, or notationName in EntityDecl. - `localname` integer — Maximum size of the localname. This applies to tags and attributes. - `max_attributes` integer — Maximum number of attributes allowed on a tag, including default ones. Note: If namespace-aware parsing is disabled, then the namespaces definitions are counted as attributes. - `max_children` integer — Maximum number of children allowed (Element, Text, Comment, ProcessingInstruction, CDATASection). Note: Adjacent text and CDATA sections are counted as one. For example, text-cdata-text-cdata is one child. - `max_depth` integer — Maximum depth of tags. Child elements such as Text or Comments are not counted as another level. - `max_namespaces` integer — Maximum number of namespaces defined on a tag. This value is required if parsing is namespace-aware. - `namespace_aware` boolean — If not parsing namespace aware, all prefixes and namespace attributes will be counted as regular attributes and element names, and validated as such. - `namespaceuri` integer — Maximum size of the namespace URI. This value is required if parsing is namespace-aware. - `pidata` integer — Maximum size of processing instruction data. - `pitarget` integer — Maximum size of processing instruction targets. - `prefix` integer — Maximum size of the prefix. This applies to tags and attributes. This value is required if parsing is namespace-aware. - `text` integer — Maximum text inside tags (counted over all adjacent text/CDATA elements combined). - `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 - `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 XmlThreatProtection plugin - XmlThreatProtectionPlugin — 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` 'xml-threat-protection', 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_dtd` boolean — Indicates whether an XML Document Type Definition (DTD) section is allowed. - `allowed_content_types` string[] — A list of Content-Type values with payloads that are allowed, but aren't validated. - `attribute` integer — Maximum size of the attribute value. - `bla_max_amplification` number — Sets the maximum allowed amplification. This protects against the Billion Laughs Attack. - `bla_threshold` integer — Sets the threshold after which the protection starts. This protects against the Billion Laughs Attack. - `buffer` integer — Maximum size of the unparsed buffer (see below). - `checked_content_types` string[] — A list of Content-Type values with payloads that must be validated. - `comment` integer — Maximum size of comments. - `document` integer — Maximum size of the entire document. - `entity` integer — Maximum size of entity values in EntityDecl. - `entityname` integer — Maximum size of entity names in EntityDecl. - `entityproperty` integer — Maximum size of systemId, publicId, or notationName in EntityDecl. - `localname` integer — Maximum size of the localname. This applies to tags and attributes. - `max_attributes` integer — Maximum number of attributes allowed on a tag, including default ones. Note: If namespace-aware parsing is disabled, then the namespaces definitions are counted as attributes. - `max_children` integer — Maximum number of children allowed (Element, Text, Comment, ProcessingInstruction, CDATASection). Note: Adjacent text and CDATA sections are counted as one. For example, text-cdata-text-cdata is one child. - `max_depth` integer — Maximum depth of tags. Child elements such as Text or Comments are not counted as another level. - `max_namespaces` integer — Maximum number of namespaces defined on a tag. This value is required if parsing is namespace-aware. - `namespace_aware` boolean — If not parsing namespace aware, all prefixes and namespace attributes will be counted as regular attributes and element names, and validated as such. - `namespaceuri` integer — Maximum size of the namespace URI. This value is required if parsing is namespace-aware. - `pidata` integer — Maximum size of processing instruction data. - `pitarget` integer — Maximum size of processing instruction targets. - `prefix` integer — Maximum size of the prefix. This applies to tags and attributes. This value is required if parsing is namespace-aware. - `text` integer — Maximum text inside tags (counted over all adjacent text/CDATA elements combined). - `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 - `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)