ACL
ACL subcommand [argument ...]
- Group
- ACL
- Arity
- -2 (at least 2 words, counting the command name)
- Flags
- admin, slow
- HotKV Cloud
- All plans
- On-Premise
- no license needed
ACL is a container command for HotKV’s access control lists: named users,
each with its own passwords, allowed commands, key patterns and pub/sub
channels. The first argument names the subcommand, and each subcommand has
its own page. See Security: ACL for how the rules work
and for typical users.
Subcommands
Section titled “Subcommands”| Subcommand | What it does |
|---|---|
| ACL CAT | List the command categories, or the commands in one. |
| ACL DELUSER | Delete users and disconnect their clients. |
| ACL DRYRUN | Check whether a user may run a command, without running it. |
| ACL GENPASS | Generate a random password. |
| ACL GETUSER | Show one user’s rules. |
| ACL LIST | Show every user as an ACL file line. |
| ACL LOAD | Reload the users from aclfile. |
| ACL LOG | Show or clear recent denied commands and failed logins. |
| ACL SAVE | Write the users to aclfile. |
| ACL SETUSER | Create a user or change its rules. |
| ACL USERS | List the user names. |
| ACL WHOAMI | The current connection’s user. |
ACL HELP lists the subcommands with a short description each.
Every ACL subcommand is in the @admin, @slow and @dangerous
categories except ACL CAT, ACL GENPASS, ACL WHOAMI and ACL HELP,
which are only @slow. Give application users +@all -@dangerous rather
than +@all, so they cannot change permissions. ACL cannot be called from
a script.
Errors
Section titled “Errors”| Case | Reply |
|---|---|
| Unknown subcommand | ERR unknown subcommand 'name'. Try ACL HELP. |
| Wrong number of arguments | ERR wrong number of arguments for 'acl|subcommand' command |
Compatibility
Section titled “Compatibility”The subcommands, rule syntax and replies follow Redis 7 and Valkey 8. HotKV
has four extra categories for its own data types: bloom, cms, topk and
timeseries.
See also
Section titled “See also”Was this page helpful?
Thanks for the feedback.