---
title: "Update a ACL plugin"
method: PUT
path: "/plugins/{PluginId}#ACL"
tags: ["Plugins"]
---

# Update a ACL plugin

`PUT /plugins/{PluginId}#ACL`

Update a ACL plugin

## Request body

- CreateACLPlugin
  - `config` object — The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).
    - `allow` string[] — Arbitrary group names that are allowed to consume the service or route. One of `config.allow` or `config.deny` must be specified.
    - `always_use_authenticated_groups` boolean — If enabled (`true`), the authenticated groups will always be used even when an authenticated consumer already exists. If the authenticated groups don't exist, it will fallback to use the groups associated with the consumer. By default the authenticated groups will only be used when there is no consumer or the consumer is anonymous.
    - `deny` string[] — Arbitrary group names that are not allowed to consume the service or route. One of `config.allow` or `config.deny` must be specified.
    - `hide_groups_header` boolean — If enabled (`true`), prevents the `X-Consumer-Groups` header from being sent in the request to the upstream service.
    - `include_consumer_groups` boolean
  - `created_at` integer — Unix epoch when the resource was created.
  - `enabled` boolean — Whether the plugin is applied.
  - `id` string
  - `instance_name` string
  - `name` 'acl' — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `protocols` string[] — A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support `"tcp"` and `"tls"`.
  - `tags` string[] — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer — Unix epoch when the resource was last updated.
  - `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
    - `id` string
  - `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 `200`

ACL plugin

- ACLPlugin
  - `config` object — The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).
    - `allow` string[] — Arbitrary group names that are allowed to consume the service or route. One of `config.allow` or `config.deny` must be specified.
    - `always_use_authenticated_groups` boolean — If enabled (`true`), the authenticated groups will always be used even when an authenticated consumer already exists. If the authenticated groups don't exist, it will fallback to use the groups associated with the consumer. By default the authenticated groups will only be used when there is no consumer or the consumer is anonymous.
    - `deny` string[] — Arbitrary group names that are not allowed to consume the service or route. One of `config.allow` or `config.deny` must be specified.
    - `hide_groups_header` boolean — If enabled (`true`), prevents the `X-Consumer-Groups` header from being sent in the request to the upstream service.
    - `include_consumer_groups` boolean
  - `created_at` integer — Unix epoch when the resource was created.
  - `enabled` boolean — Whether the plugin is applied.
  - `id` string
  - `instance_name` string
  - `name` 'acl' — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `protocols` string[] — A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support `"tcp"` and `"tls"`.
  - `tags` string[] — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer — Unix epoch when the resource was last updated.
  - `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
    - `id` string
  - `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

## Changes

> 3 revisions in range; 1 not diffed.

- **2024-09-11** `5bd52189d290` — 6 info
  - added the new optional request property `allOf[#/components/schemas/ACLPluginConfig]/config/always_use_authenticated_groups`
  - added the new optional request property `allOf[#/components/schemas/Plugin]/allOf[#/components/schemas/PluginWithoutParents]/ordering/after`
  - added the new optional request property `allOf[#/components/schemas/Plugin]/allOf[#/components/schemas/PluginWithoutParents]/ordering/before`
  - added the optional property `allOf[#/components/schemas/ACLPluginConfig]/config/always_use_authenticated_groups` to the response with the `200` status
  - …2 more

[Change history](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/changes/plugins/:PluginId#ACL/put.md)

---

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