Method |
Path |
Description |
GET |
/v1/redis_acls |
Get all Redis ACLs |
GET |
/v1/redis_acls/{uid} |
Get a single Redis ACL |
PUT |
/v1/redis_acls/{uid} |
Update a Redis ACL |
POST |
/v1/redis_acls |
Create a new Redis ACL |
DELETE |
/v1/redis_acls/{uid} |
Delete a Redis ACL |
Get all Redis ACLs
GET /v1/redis_acls
Get all Redis ACL objects.
Required permissions
Request
Example HTTP request
GET /redis_acls
Key |
Value |
Description |
Host |
cnm.cluster.fqdn |
Domain name |
Accept |
application/json |
Accepted media type |
Response
Returns a JSON array of Redis ACL objects.
Example JSON body
[
{
"uid": 1,
"name": "Full Access",
"acl": "[email protected] ~*"
},
{
"uid": 2,
"name": "Read Only",
"acl": "[email protected] ~*"
},
{
"uid": 3,
"name": "Not Dangerous",
"acl": "[email protected] [email protected] ~*"
},
{
"uid": 17,
"name": "Geo",
"acl": "~* [email protected]"
}
]
Status codes
Get Redis ACL
GET /v1/redis_acls/{int: uid}
Get a single Redis ACL object.
Required permissions
Request
Example HTTP request
GET /redis_acls/1
Key |
Value |
Description |
Host |
cnm.cluster.fqdn |
Domain name |
Accept |
application/json |
Accepted media type |
URL parameters
Field |
Type |
Description |
uid |
integer |
The object’s unique ID. |
Response
Returns a Redis ACL object.
Example JSON body
Status codes
Update Redis ACL
PUT /v1/redis_acls/{int: uid}
Update an existing Redis ACL object.
Required permissions
Request
Example HTTP request
PUT /redis_acls/17
Example JSON body
Key |
Value |
Description |
Host |
cnm.cluster.fqdn |
Domain name |
Accept |
application/json |
Accepted media type |
Request body
Include a Redis ACL object with updated fields in the request body.
Response
Returns the updated Redis ACL object.
Example JSON body
Error codes
Possible error_code
values:
Code |
Description |
unsupported_resource |
The cluster is not yet able to handle this resource type. This could happen in a partially upgraded cluster, where some of the nodes are still on a previous version. |
name_already_exists |
An object of the same type and name exists |
invalid_param |
A parameter has an illegal value |
Status codes
Create Redis ACL
POST /v1/redis_acls
Create a new Redis ACL object.
Required permissions
Request
Example HTTP request
POST /redis_acls
Example JSON body
Key |
Value |
Description |
Host |
cnm.cluster.fqdn |
Domain name |
Accept |
application/json |
Accepted media type |
Request body
Include a Redis ACL object in the request body.
Response
Returns the newly created Redis ACL object.
Example JSON body
Error codes
Possible error_code
values:
Code |
Description |
unsupported_resource |
The cluster is not yet able to handle this resource type. This could happen in a partially upgraded cluster, where some of the nodes are still on a previous version. |
name_already_exists |
An object of the same type and name exists |
missing_field |
A needed field is missing |
invalid_param |
A parameter has an illegal value |
Status codes
Delete Redis ACL
DELETE /v1/redis_acls/{int: uid}
Delete a Redis ACL object.
Required permissions
Request
Example HTTP request
DELETE /redis_acls/1
Key |
Value |
Description |
Host |
cnm.cluster.fqdn |
Domain name |
Accept |
application/json |
Accepted media type |
URL parameters
Field |
Type |
Description |
uid |
integer |
The redis_acl unique ID. |
Response
Returns a status code that indicates the Redis ACL deletion success or failure.
Status codes