> For the complete documentation index, see [llms.txt](https://docs.warpstream.com/warpstream/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.warpstream.com/warpstream/reference/api-reference/acls.md).

# ACLs

This API allows you to manage Kafka ACLs (Access Control Lists) for your WarpStream virtual clusters.

ACL rules are only *enforced* on Kafka traffic once ACLs are [enabled on the virtual cluster](/warpstream/kafka/manage-security/configure-acls.md#enabling-and-disabling-acls). This lets you set up your ACL rules before turning on enforcement. You can enable ACLs via the [UpdateConfiguration](/warpstream/reference/api-reference/virtual-clusters/updateconfiguration.md) endpoint by setting `are_acls_enabled` to `true`.

For general information about ACLs in WarpStream, including principals, super users, and caching behavior, see the [ACLs guide](/warpstream/kafka/manage-security/configure-acls.md).

## ACL Fields

Each ACL rule consists of the following fields:

| Field             | Description                                                                                                                                                              |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `resource_type`   | The type of Kafka resource. One of: `TOPIC`, `GROUP`, `CLUSTER`, `TRANSACTIONAL_ID`, `DELEGATION_TOKEN`, `ANY`.                                                          |
| `resource_name`   | The name of the resource (e.g., topic name, consumer group name). For `CLUSTER` resources, use `kafka-cluster`.                                                          |
| `pattern_type`    | How the resource name is matched. One of: `LITERAL` (exact match), `PREFIXED` (prefix match).                                                                            |
| `principal`       | The user principal in the format `User:<name>`. See [ACL Principals](/warpstream/kafka/manage-security/configure-acls.md#acl-principal) for details.                     |
| `host`            | The client host. Use `*` to allow all hosts.                                                                                                                             |
| `operation`       | The Kafka operation. One of: `ALL`, `READ`, `WRITE`, `CREATE`, `DELETE`, `ALTER`, `DESCRIBE`, `CLUSTER_ACTION`, `DESCRIBE_CONFIGS`, `ALTER_CONFIGS`, `IDEMPOTENT_WRITE`. |
| `permission_type` | Whether to allow or deny the operation. One of: `ALLOW`, `DENY`.                                                                                                         |
| `created_at`      | Read-only. When the ACL was created, as an RFC 3339 UTC timestamp. Only returned by [List ACLs](/warpstream/reference/api-reference/acls/list-acls.md).                  |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.warpstream.com/warpstream/reference/api-reference/acls.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.