Instaclustr Logo
Powered by Redocly

Valkey User V2

List all Valkey users.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the cluster.

Responses
200

Successfully retrieved application users of Valkey.

get/cluster-management/v2/data-sources/valkey_cluster/{clusterId}/users/v2/
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create a Valkey User.
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
password
required
string <password> 
Password for the Valkey user.


 
clusterId
required
string <uuid> 
ID of the Valkey cluster.


 
initialPermissions
required
string
Permissions initially granted to Valkey user upon creation.


 Enum: "standard" "read-only" "none"  
username
required
string^(?![zZ][oO][oO][kK][eE][eE][pP][eE][rR]$)[a-...
Username of the Valkey user.


 
Responses 
202
Valkey user provisioning requested.


post/cluster-management/v2/resources/applications/valkey/users/v2/
Request samples 
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myValkeyUser",
  • "initialPermissions": "standard",
  • "password": "myPassword0.",
  • "username": "myValkeyUser"
}
Response samples 
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myValkeyUser",
  • "initialPermissions": "standard",
  • "password": "myPassword0.",
  • "username": "myValkeyUser"
}
Get Valkey User details.
SecurityBasic Authentication 
Request 
path Parameters
valkeyUserId
required
string
ID of the Valkey user.


 
Responses 
200
Valkey user details retrieved.


get/cluster-management/v2/resources/applications/valkey/users/v2/{valkeyUserId}/
Request samples 
Response samples 
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myValkeyUser",
  • "initialPermissions": "standard",
  • "password": "myPassword0.",
  • "username": "myValkeyUser"
}
Update Valkey user password
SecurityBasic Authentication 
Request 
path Parameters
valkeyUserId
required
string
ID of the Valkey user.


 
Request Body schema: application/json
required
password
required
string <password> 
Password for the Valkey user.


 
Responses 
202
Requested Valkey user's password update.


404
Valkey cluster not found.


503
Service Unavailable


504
Gateway Timeout


put/cluster-management/v2/resources/applications/valkey/users/v2/{valkeyUserId}/
Request samples 
application/json
{
  • "password": "my1password!"
}
Response samples 
application/json
{
  • "password": "my1password!"
}
Delete a Valkey user
SecurityBasic Authentication 
Request 
path Parameters
valkeyUserId
required
string
ID of the Valkey user.


 
Responses 
204
Valkey user delete requested.


delete/cluster-management/v2/resources/applications/valkey/users/v2/{valkeyUserId}/
Request samples 
➔ Next to Authentication & Rate Limit