ACL CAT - Upstash Documentation

Use ACL CAT to discover the category names usable in ACL SETUSER rules such as +@read or -@dangerous.

Called without an argument, it returns every category name the server knows, for example read, write, keyspace, dangerous, admin, scripting, and the categories for individual data types such as string, hash, or json. Called with a category name, it instead returns the commands that belong to that category, which is the fastest way to check exactly what a rule like +@json grants before applying it to a user.

Syntax#

ACL CAT [category]

Arguments#

Argument	Required	Repeatable	Description
`category`	No	No	When given, list the commands in this category instead of listing category names.

Important points#

An unknown category name returns an error rather than an empty list.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Array of bulk strings
RESP3	Array of bulk strings

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

ACL CAT read

@upstash/redis

Note

This command is not supported yet in @upstash/redis.

upstash_redis

Note

This command is not supported yet in upstash_redis.

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.acl("CAT", "read");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.aclCat("read");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.acl_cat("read")print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.ACLCatArgs(context.Background(), &redis.ACLCatArgs{        Category: "read",    }).Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.aclCat("read");  System.out.println(result);}

redis-rs

use redis::TypedCommands;fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let result = connection.acl_cat_categoryname("read")?;    println!("{result:?}");    Ok(())}