List ACLs

Lists all ACL rules configured on a virtual cluster.

Requires admin or read-only permissions.

Request

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"}'

Response

{
  "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:

{
  "acls": []
}