Sign in

v25

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015053126.2 KB
Roles

Create a new Redis Software role

Create a new role with the provided configuration.

post/v1/roles

Query parameters

dry_runboolean

Validate the request without persisting changes.

Request body

account_idinteger

Account ID. Only applicable to account-scoped roles.

management'none' | 'db_viewer' | 'cluster_viewer' | 'db_member' | 'cluster_member' | 'user_manager' | 'admin'

Name of the management role.

namestring

Role's name.

uidinteger

Optional uid to assign to the role.

Example request

{
  "management": "cluster_viewer",
  "name": "Support Engineer"
}

Response

Role created successfully.

account_idinteger

Account ID. Only applicable to account-scoped roles.

management'none' | 'db_viewer' | 'cluster_viewer' | 'db_member' | 'cluster_member' | 'user_manager' | 'admin' required

Name of the management role.

namestring required

Role's name.

uidinteger required

Role's unique uid.

Example response

{
  "management": "cluster_member",
  "name": "DBA",
  "uid": 1
}