# List ACLs

Lists all ACL rules configured on a virtual cluster.

Requires admin or read-only permissions.

## Request

{% code overflow="wrap" %}

```bash
curl https://api.warpstream.com/api/v1/virtual_clusters/acls/list \
-H 'warpstream-api-key: XXXXXXXXXX' \
-H 'Content-Type: application/json' \
-d '{"virtual_cluster_id": "vci_1d4930d7_8e6d_4ad9_b27a_654ed4aaa3ee"}'
```

{% endcode %}

## Response

```json
{
  "acls": [
    {
      "resource_type": "TOPIC",
      "resource_name": "orders",
      "pattern_type": "LITERAL",
      "principal": "User:alice",
      "host": "*",
      "operation": "READ",
      "permission_type": "ALLOW"
    },
    {
      "resource_type": "TOPIC",
      "resource_name": "events",
      "pattern_type": "PREFIXED",
      "principal": "User:bob",
      "host": "*",
      "operation": "WRITE",
      "permission_type": "ALLOW"
    }
  ]
}
```

If no ACLs are configured, the response will contain an empty array:

```json
{
  "acls": []
}
```


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

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

The question should be specific, self-contained, and written in natural language.
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.
