From 6034fc6c2d4df81641640538b7515d2727966007 Mon Sep 17 00:00:00 2001 From: "redis-enterprise-doc-sync[bot]" <246451900+redis-enterprise-doc-sync[bot]@users.noreply.github.com> Date: Sat, 31 Jan 2026 06:09:04 +0000 Subject: [PATCH 1/3] Update Redis Enterprise API specification --- .../rest-api/api-reference/openapi.json | 2237 +++++++++++++++-- 1 file changed, 2005 insertions(+), 232 deletions(-) diff --git a/content/operate/rs/references/rest-api/api-reference/openapi.json b/content/operate/rs/references/rest-api/api-reference/openapi.json index c4d64c0b13..529e702f8f 100644 --- a/content/operate/rs/references/rest-api/api-reference/openapi.json +++ b/content/operate/rs/references/rest-api/api-reference/openapi.json @@ -11,6 +11,16 @@ }, "description": "Bad Request" }, + "Conflict": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Conflict" + }, "Forbidden": { "content": { "application/json": { @@ -40,314 +50,1976 @@ } }, "description": "Not Found" + }, + "ServiceUnavailable": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Service Unavailable" } }, "schemas": { - "Error": { + "ActiveActive": { "properties": { - "description": { - "description": "Human-readable error description", + "available": { + "description": "Whether every replication link is up", + "type": "boolean" + }, + "participating_clusters": { + "items": { + "$ref": "#/components/schemas/Source" + }, + "type": "array" + } + }, + "required": [ + "available", + "participating_clusters" + ], + "type": "object" + }, + "Alert": { + "description": "Alert information", + "properties": { + "active_since": { + "description": "Since what time the alert is active", + "format": "date-time", "type": "string" }, - "error_code": { - "description": "Semantic error code (e.g., password_not_complex)", + "name": { + "description": "Alert name", "type": "string" }, - "status_code": { - "type": "integer", - "x-go-json-ignore": true + "threshold": { + "description": "Threshold for the alert", + "type": "string" } }, "required": [ - "error_code", - "description", - "status_code" - ] - }, - "PasswordHashMethod": { - "description": "Used when password is passed pre-hashed", - "enum": [ - 1 + "name", + "active_since" ], - "type": "integer", - "x-enum-varnames": [ - "PreHashed" - ] + "type": "object" }, - "Permissions": { - "description": "API and UI permissions for a role", + "BdbPasswordRequest": { + "description": "Request body for database password operations", "example": { - "api_permissions": [ - "create_node", - "update_node", - "delete_node" - ], - "ui_permissions": [ - "view_cluster_page", - "view_database_page" - ] + "password": "my-secure-password" }, "properties": { - "api_permissions": { - "description": "List of permission strings", + "password": { + "description": "The password to add, delete, or set", + "type": "string" + } + }, + "required": [ + "password" + ], + "type": "object" + }, + "Certificate": { + "description": "Certificate information.", + "properties": { + "expired": { + "description": "Whether the certificate has expired", + "type": "boolean" + }, + "type": { + "description": "Certificate type", + "type": "string" + }, + "valid_until": { + "description": "Certificate expiration time", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "type", + "expired", + "valid_until" + ], + "type": "object" + }, + "ChangePasswordHashingAlgorithmRequest": { + "description": "Request to change the cluster password hashing algorithm", + "properties": { + "algorithm": { + "description": "The password hashing algorithm to use for all users", + "enum": [ + "SHA-256", + "PBKDF2" + ], + "type": "string" + } + }, + "required": [ + "algorithm" + ], + "type": "object" + }, + "ClusterHealthReport": { + "description": "Cluster health report.", + "properties": { + "active_alerts": { "items": { - "type": "string" + "$ref": "#/components/schemas/Alert" }, "type": "array" }, - "ui_permissions": { - "description": "List of permission strings", + "certificates": { + "description": "List of certificates in the cluster", "items": { - "type": "string" + "$ref": "#/components/schemas/Certificate" + }, + "type": "array" + }, + "database_infos": { + "items": { + "$ref": "#/components/schemas/DatabaseInfo" + }, + "type": "array" + }, + "fqdn": { + "description": "Cluster FQDN", + "type": "string" + }, + "license": { + "$ref": "#/components/schemas/LicenseHealthReport" + }, + "nodes": { + "description": "List of nodes in the cluster", + "items": { + "$ref": "#/components/schemas/Node" }, "type": "array" + }, + "status": { + "description": "Cluster status", + "enum": [ + "error", + "warning", + "ok" + ], + "type": "string" } }, - "type": "object" - }, - "RoleName": { - "description": "Name of the management role.", - "enum": [ - "none", - "db_viewer", - "cluster_viewer", - "db_member", - "cluster_member", - "user_manager", - "admin" + "required": [ + "fqdn", + "status", + "license", + "certificates", + "nodes", + "active_alerts", + "database_infos" ], - "type": "string" - }, - "RolesWithPermissions": { - "additionalProperties": { - "$ref": "#/components/schemas/Permissions" - }, - "description": "A map of role names to their permissions", "type": "object" }, - "User": { - "description": "An API object that represents an Redis Enterprise Cluster user.", - "example": { - "auth_method": "regular", - "email": "user@redis.com", - "email_alerts": true, - "last_login": 1760618047, - "name": "John Doe", - "password_issue_date": "2025-03-02T09:43:34Z", - "role_uids": [ - 1 - ], - "status": "active" - }, + "DatabaseHealthReport": { "properties": { - "account_id": { - "description": "SM account ID", - "type": "integer" + "active_active": { + "$ref": "#/components/schemas/ActiveActive" }, - "action_uid": { - "description": "Action uid. If exists - progress can be tracked by the GET /actions/\u003cuid\u003e API", + "active_alerts": { + "description": "List of active alerts for the database", + "items": { + "$ref": "#/components/schemas/Alert" + }, + "type": "array" + }, + "availability": { + "$ref": "#/components/schemas/replication_status" + }, + "creation_time": { + "description": "Database creation time.", + "format": "date-time", "type": "string" }, - "auth_method": { + "detailed_status": { + "$ref": "#/components/schemas/database_detailed_status" + }, + "endpoints": { + "description": "Database endpoints.", + "items": { + "$ref": "#/components/schemas/Endpoint" + }, + "type": "array" + }, + "high_availability": { + "$ref": "#/components/schemas/HighAvailability" + }, + "id": { + "description": "Database id", + "type": "string" + }, + "last_backup_time": { + "description": "Database last backup time.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "last_configured_time": { + "description": "Database last configuration time.", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "Database name", + "type": "string" + }, + "persistence": { + "default": "disabled", + "description": "Database persistence type.", "enum": [ - "regular", - "certificate", - "entraid", - "sso" + "disabled", + "aof", + "rdb" ], "type": "string" }, - "bdbs_email_alerts": { - "description": "UIDs of databases that user will receive alerts for.", + "shards": { + "description": "Database shards.", "items": { - "type": "string" + "$ref": "#/components/schemas/ShardHealthReport" }, - "type": "array", - "uniqueItems": true + "type": "array" }, - "certificate_subject_line": { - "description": "The certificate's subject line as defined by RFC2253 (for certificate based authentication users only)", + "shards_placement": { + "description": "Database shards placement.", + "enum": [ + "dense", + "sparse" + ], "type": "string" }, - "cluster_email_alerts": { - "description": "Activate cluster email alerts for a user.", - "type": "boolean" + "state_machine": { + "$ref": "#/components/schemas/StateMachine" }, - "email": { - "description": "User's email. (pattern matching only ascii characters)", + "status": { + "$ref": "#/components/schemas/database_status" + }, + "version": { + "description": "Database version.", "type": "string" + } + }, + "required": [ + "id", + "name", + "availability", + "high_availability", + "status", + "detailed_status", + "version", + "creation_time", + "last_configured_time", + "persistence", + "shards_placement", + "endpoints", + "shards", + "active_alerts" + ], + "type": "object" + }, + "DatabaseInfo": { + "description": "Database info", + "properties": { + "detailed_status": { + "$ref": "#/components/schemas/database_detailed_status" }, - "email_alerts": { - "default": true, - "description": "Activate email alerts for a user.", - "type": "boolean" + "high_availability": { + "$ref": "#/components/schemas/HighAvailability" }, - "last_login": { - "description": "Timestamp of the user's last login time. This denotes the last time an authentication with the user's credentials was successful.", - "format": "int64", - "type": "integer" + "id": { + "description": "DB id", + "type": "string" }, "name": { - "description": "User's name. (pattern does not allow non ascii and special characters \u0026,\u003c,\u003e,\")", + "description": "DB name", "type": "string" }, - "password": { - "description": "User's password. Note that it could also be an already-hashed value, in which case 'password_hash_method' parameter is also provided.", + "status": { + "$ref": "#/components/schemas/database_status" + }, + "version": { + "description": "DB version", "type": "string" + } + }, + "required": [ + "id", + "name", + "status", + "detailed_status", + "version", + "high_availability" + ], + "type": "object" + }, + "Endpoint": { + "description": "Endpoint information", + "properties": { + "availability": { + "$ref": "#/components/schemas/replication_status" }, - "password_issue_date": { - "description": "The date in which the password was set.", - "format": "date-time", + "name": { + "description": "Endpoint name", + "type": "string" + } + }, + "required": [ + "name", + "availability" + ], + "type": "object" + }, + "Error": { + "properties": { + "description": { + "description": "Human-readable error description", "type": "string" }, - "role": { - "allOf": [ - { - "$ref": "#/components/schemas/RoleName" - } - ], - "deprecated": true, + "error_code": { + "description": "Semantic error code (e.g., password_not_complex)", + "type": "string" + }, + "status_code": { + "type": "integer", + "x-go-json-ignore": true + } + }, + "required": [ + "error_code", + "description", + "status_code" + ] + }, + "HighAvailability": { + "properties": { + "status": { + "$ref": "#/components/schemas/high_availability_status" + } + }, + "required": [ + "status" + ], + "type": "object" + }, + "LicenseHealthReport": { + "description": "License health report.", + "properties": { + "expired": { + "description": "Whether the license has expired", + "type": "boolean" + }, + "flex_shards_in_use": { + "description": "Number of Flex shards in use by databases in the cluster", + "type": "integer" + }, + "flex_shards_limit": { + "description": "Flex shards limit specified in cluster license", + "type": "integer" + }, + "ram_shards_in_use": { + "description": "Number of RAM shards in use by databases in the cluster", + "type": "integer" + }, + "ram_shards_limit": { + "description": "RAM shards limit specified in cluster license", + "type": "integer" + }, + "shards_in_use": { + "description": "Accumulated number of shards in use by databases in the cluster", + "type": "integer" + }, + "shards_limit": { + "description": "Shards limit specified in cluster license", + "type": "integer" + }, + "valid_until": { + "description": "License expiration time", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "expired", + "shards_in_use", + "ram_shards_in_use", + "flex_shards_in_use", + "shards_limit", + "ram_shards_limit", + "flex_shards_limit", + "valid_until" + ], + "type": "object" + }, + "Memory": { + "description": "Memory information", + "properties": { + "free_provisional_ram": { + "description": "Remaining ram for provisioning new shards on the node", + "format": "int64", + "type": "integer" + }, + "free_ram": { + "description": "Free ram the node has in bytes", + "format": "int64", + "type": "integer" + }, + "overbooking_depth": { + "description": "How much the node is overbooked or has capacity remaining, like free provisional ram but takes into account shards_overbooking (can be negative if it is overbooked)", + "format": "int64", + "type": "integer" + }, + "total_provisional_ram": { + "description": "Total ram for provisioning shards on the node", + "format": "int64", + "type": "integer" + }, + "total_ram": { + "description": "Total ram the node has in bytes", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "total_ram", + "free_ram", + "free_provisional_ram", + "total_provisional_ram", + "overbooking_depth" + ], + "type": "object" + }, + "Node": { + "description": "Node information.", + "properties": { + "detailed_status": { + "description": "Node detailed status", + "enum": [ + "down", + "provisioning", + "decommissioning", + "active" + ], + "type": "string" + }, + "ephemeral_memory_path": { + "description": "Path to ephemeral storage on the node", + "type": "string" + }, + "ephemeral_memory_size": { + "description": "Size of ephemeral storage on the node in bytes", + "format": "double", + "type": "number" + }, + "id": { + "description": "Node id", + "type": "string" + }, + "in_maintenance": { + "description": "Whether the node is in maintenance mode", + "type": "boolean" + }, + "memory": { + "$ref": "#/components/schemas/Memory" + }, + "observed_at": { + "description": "Unix time in seconds when the value was last written in the CCS", + "format": "int64", + "type": "integer" + }, + "persistent_memory_path": { + "description": "Path to persistent storage on the node", + "type": "string" + }, + "persistent_memory_size": { + "description": "Size of persistent storage on the node in bytes", + "format": "double", + "type": "number" + }, + "quorum_only": { + "description": "Whether the node is quorum-only (does not accept servers)", + "type": "boolean" + }, + "role": { + "description": "Node role can be leader or follower", + "enum": [ + "leader", + "follower" + ], + "type": "string" + }, + "services": { + "items": { + "$ref": "#/components/schemas/Service" + }, + "type": "array" + }, + "shards": { + "description": "Shards on the node.", + "items": { + "$ref": "#/components/schemas/ShardHealthReport" + }, + "type": "array" + }, + "status": { + "description": "Node status", + "enum": [ + "down", + "warning", + "active" + ], + "type": "string" + }, + "version": { + "description": "RS version installed on the node", + "type": "string" + } + }, + "required": [ + "id", + "status", + "detailed_status", + "role", + "version", + "shards", + "memory", + "observed_at", + "services", + "ephemeral_memory_path", + "ephemeral_memory_size", + "persistent_memory_path", + "persistent_memory_size", + "quorum_only", + "in_maintenance" + ], + "type": "object" + }, + "PasswordHashMethod": { + "description": "Used when password is passed pre-hashed", + "enum": [ + 1 + ], + "type": "integer", + "x-enum-varnames": [ + "PreHashed" + ] + }, + "Permissions": { + "description": "API and UI permissions for a role", + "example": { + "api_permissions": [ + "create_node", + "update_node", + "delete_node" + ], + "ui_permissions": [ + "view_cluster_page", + "view_database_page" + ] + }, + "properties": { + "api_permissions": { + "description": "List of permission strings", + "items": { + "type": "string" + }, + "type": "array" + }, + "ui_permissions": { + "description": "List of permission strings", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RedisAcl": { + "description": "An API object that represents a Redis ACL definition.", + "example": { + "acl": "on \u003eallcommands allkeys", + "max_version": "9999", + "min_version": "6.2", + "name": "default", + "uid": 1 + }, + "properties": { + "account_id": { + "description": "SM account ID associated with this ACL.", + "type": "integer", + "x-go-type": "int64" + }, + "acl": { + "description": "Redis ACL string definition.", + "type": "string" + }, + "action_uid": { + "description": "Action uid. If exists - progress can be tracked by the GET /actions/\u003cuid\u003e API", + "readOnly": true, + "type": "string" + }, + "max_version": { + "description": "Maximum Redis version for which this ACL is valid.", + "readOnly": true, + "type": "string" + }, + "min_version": { + "description": "Minimum Redis version for which this ACL is valid.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "ACL name.", + "pattern": "^[a-zA-Z0-9_ \\[\\]()@,.;#-]+$", + "type": "string" + }, + "uid": { + "description": "Redis ACL unique uid.", + "type": "integer", + "x-go-type": "json.Number" + } + }, + "type": "object" + }, + "Role": { + "allOf": [ + { + "$ref": "#/components/schemas/RoleBody" + }, + { + "properties": { + "uid": { + "description": "Role's unique uid.", + "type": "integer", + "x-go-type": "json.Number" + } + }, + "required": [ + "uid", + "name", + "management" + ], + "type": "object" + } + ], + "description": "An API object that represents a Redis Enterprise role.", + "example": { + "management": "admin", + "name": "DBA", + "uid": 1 + } + }, + "RoleBody": { + "description": "Common role properties shared across role payloads.", + "properties": { + "account_id": { + "description": "Account ID. Only applicable to account-scoped roles.", + "type": "integer" + }, + "management": { + "$ref": "#/components/schemas/RoleName" + }, + "name": { + "description": "Role's name.", + "pattern": "^[a-zA-Z0-9_ \\[\\]()@,.;#-]+$", + "type": "string" + } + }, + "type": "object" + }, + "RoleCreateRequest": { + "allOf": [ + { + "$ref": "#/components/schemas/RoleBody" + }, + { + "properties": { + "uid": { + "description": "Optional uid to assign to the role.", + "type": "integer", + "x-go-type": "json.Number" + } + }, + "type": "object" + } + ], + "description": "Role creation request payload.", + "example": { + "management": "cluster_viewer", + "name": "Support Engineer" + } + }, + "RoleName": { + "description": "Name of the management role.", + "enum": [ + "none", + "db_viewer", + "cluster_viewer", + "db_member", + "cluster_member", + "user_manager", + "admin" + ], + "type": "string" + }, + "RoleUpdateRequest": { + "allOf": [ + { + "$ref": "#/components/schemas/RoleBody" + }, + { + "type": "object" + } + ], + "description": "Role update request payload.", + "example": { + "management": "cluster_member" + } + }, + "RolesWithPermissions": { + "additionalProperties": { + "$ref": "#/components/schemas/Permissions" + }, + "description": "A map of role names to their permissions", + "type": "object" + }, + "Service": { + "description": "Services running on the node managed by supervisor", + "properties": { + "name": { + "description": "Name of the service", + "type": "string" + }, + "status": { + "description": "Status of the service corresponding to the statename returned by supervisor", + "type": "string" + } + }, + "required": [ + "name", + "status" + ], + "type": "object" + }, + "ShardHealthReport": { + "properties": { + "detailed_status": { + "description": "shard detailed status", + "enum": [ + "ok", + "importing", + "timeout", + "loading", + "busy", + "down", + "trimming", + "unknown" + ], + "type": "string" + }, + "id": { + "type": "string" + }, + "role": { + "description": "shard role can be leader or follower", + "enum": [ + "leader", + "follower" + ], + "type": "string" + }, + "status": { + "description": "shard status can be up or trimming", + "enum": [ + "active", + "inactive", + "trimming" + ], + "type": "string" + } + }, + "required": [ + "id", + "role", + "status", + "detailed_status" + ], + "type": "object" + }, + "Source": { + "properties": { + "fqdn": { + "description": "fqdn of the cluster", + "type": "string" + }, + "replica_id": { + "type": "string" + }, + "replication": { + "description": "replication status of replica", + "enum": [ + "down", + "warning", + "up" + ], + "type": "string" + } + }, + "required": [ + "fqdn", + "replication", + "replica_id" + ], + "type": "object" + }, + "StateMachine": { + "description": "State machine information", + "properties": { + "actions": { + "description": "State machine actions", + "type": "string" + }, + "name": { + "description": "State machine name", + "type": "string" + } + }, + "required": [ + "name", + "actions" + ], + "type": "object" + }, + "User": { + "description": "An API object that represents an Redis Enterprise Cluster user.", + "example": { + "auth_method": "regular", + "email": "user@redis.com", + "email_alerts": true, + "last_login": 1760618047, + "name": "John Doe", + "password_issue_date": "2025-03-02T09:43:34Z", + "role_uids": [ + 1 + ], + "status": "active" + }, + "properties": { + "account_id": { + "description": "SM account ID", + "type": "integer" + }, + "action_uid": { + "description": "Action uid. If exists - progress can be tracked by the GET /actions/\u003cuid\u003e API", + "type": "string" + }, + "auth_method": { + "enum": [ + "regular", + "certificate", + "entraid", + "sso" + ], + "type": "string" + }, + "bdbs_email_alerts": { + "description": "UIDs of databases that user will receive alerts for.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "certificate_subject_line": { + "description": "The certificate's subject line as defined by RFC2253 (for certificate based authentication users only)", + "type": "string" + }, + "cluster_email_alerts": { + "description": "Activate cluster email alerts for a user.", + "type": "boolean" + }, + "email": { + "description": "User's email. (pattern matching only ascii characters)", + "type": "string" + }, + "email_alerts": { + "default": true, + "description": "Activate email alerts for a user.", + "type": "boolean" + }, + "last_login": { + "description": "Timestamp of the user's last login time. This denotes the last time an authentication with the user's credentials was successful.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "User's name. (pattern does not allow non ascii and special characters \u0026,\u003c,\u003e,\")", + "type": "string" + }, + "password": { + "description": "User's password. Note that it could also be an already-hashed value, in which case 'password_hash_method' parameter is also provided.", + "type": "string" + }, + "password_issue_date": { + "description": "The date in which the password was set.", + "format": "date-time", + "type": "string" + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/RoleName" + } + ], + "deprecated": true, + "description": "(deprecated) User's role.", + "x-deprecated-reason": "Use role_uids instead" + }, + "role_uids": { + "description": "List of role uids associated with the user", + "items": { + "type": "integer", + "x-go-type": "json.Number" + }, + "type": "array" + }, + "status": { + "description": "Status of the user.", + "enum": [ + "active", + "locked", + "password_expired" + ], + "type": "string" + }, + "uid": { + "description": "User's unique uid.", + "type": "integer", + "x-go-type": "json.Number" + } + }, + "required": [ + "uid", + "name", + "role", + "role_uids", + "auth_method" + ], + "type": "object" + }, + "UserRequest": { + "description": "User modification request.", + "properties": { + "account_id": { + "description": "SM account ID", + "type": "integer" + }, + "auth_method": { + "enum": [ + "regular", + "certificate", + "entraid", + "sso" + ], + "type": "string" + }, + "bdbs_email_alerts": { + "description": "UIDs of databases that user will receive alerts for.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "certificate_subject_line": { + "description": "The certificate's subject line as defined by RFC2253 (for certificate based authentication users only)", + "type": "string" + }, + "cluster_email_alerts": { + "description": "Activate cluster email alerts for a user.", + "type": "boolean" + }, + "email": { + "description": "User's email.", + "pattern": "(^$|^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$)", + "type": "string" + }, + "email_alerts": { + "description": "Activate email alerts for a user.", + "type": "boolean" + }, + "name": { + "description": "User's name. (pattern does not allow non ascii and special characters \u0026,\u003c,\u003e,\")", + "maxLength": 255, + "minLength": 1, + "pattern": "^[ -!#-%'-;=?-~]+$", + "type": "string" + }, + "password": { + "description": "User's password for regular authentication. Required for regular auth method.", + "type": "string" + }, + "password_hash_method": { + "$ref": "#/components/schemas/PasswordHashMethod" + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/RoleName" + } + ], + "deprecated": true, "description": "(deprecated) User's role.", - "x-deprecated-reason": "Use role_uids instead" + "x-deprecated-reason": "Use role_uids instead", + "x-sunset": "2027-12-31" + }, + "role_uids": { + "description": "List of role uids associated with the user", + "items": { + "type": "integer", + "x-go-type": "json.Number" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "uid": { + "description": "User's unique uid.", + "minimum": 1, + "type": "integer", + "x-go-type": "json.Number" + } + }, + "type": "object" + }, + "database_detailed_status": { + "default": "unknown", + "description": "The database detailed status", + "enum": [ + "active", + "active-change-pending", + "pending", + "import-pending", + "delete-pending", + "recovery", + "creation-failed", + "unknown" + ], + "type": "string" + }, + "database_status": { + "description": "Database status", + "enum": [ + "active", + "warning", + "down" + ], + "type": "string" + }, + "high_availability_status": { + "description": "The high availability status", + "enum": [ + "down", + "up", + "disabled" + ], + "type": "string" + }, + "replication_status": { + "description": "The replication link status", + "enum": [ + "down", + "up" + ], + "type": "string" + } + }, + "securitySchemes": { + "Auth": { + "in": "header", + "name": "r-auth-user", + "type": "apiKey" + }, + "auth": { + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "Redis Enterprise Software REST API reference. This API reference is still a work in progress. For more API paths, see the [REST API requests](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/) reference pages.", + "title": "Redis Enterprise Software REST API", + "version": "1.0.0" + }, + "openapi": "3.0.0", + "paths": { + "/v1/bdbs/{uid}/passwords": { + "delete": { + "description": "Delete a password from the database's default user password list", + "operationId": "cluster_delete_bdb_password", + "parameters": [ + { + "description": "The database unique ID", + "example": 1, + "in": "path", + "name": "uid", + "required": true, + "schema": { + "type": "integer", + "x-go-type": "json.Number" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "example": { + "password": "password-to-delete" + }, + "schema": { + "$ref": "#/components/schemas/BdbPasswordRequest" + } + } + }, + "description": "Password to delete", + "required": true + }, + "responses": { + "200": { + "description": "Password deleted successfully" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "406": { + "$ref": "#/components/responses/NotAcceptable" + } + }, + "security": [ + { + "Auth": [ + "update_bdb" + ] + } + ], + "summary": "Delete a password from a database's default user", + "tags": [ + "Database" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + }, + "post": { + "description": "Add a new password to the database's default user password list for AUTH authentication", + "operationId": "cluster_add_bdb_password", + "parameters": [ + { + "description": "The database unique ID", + "example": 1, + "in": "path", + "name": "uid", + "required": true, + "schema": { + "type": "integer", + "x-go-type": "json.Number" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "example": { + "password": "new-password-to-add" + }, + "schema": { + "$ref": "#/components/schemas/BdbPasswordRequest" + } + } + }, + "description": "Password to add", + "required": true + }, + "responses": { + "200": { + "description": "Password added successfully" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "406": { + "$ref": "#/components/responses/NotAcceptable" + } + }, + "security": [ + { + "Auth": [ + "update_bdb" + ] + } + ], + "summary": "Add a password to a database's default user", + "tags": [ + "Database" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + }, + "put": { + "description": "Reset the database's default user to a single password, replacing all existing passwords", + "operationId": "cluster_reset_bdb_password", + "parameters": [ + { + "description": "The database unique ID", + "example": 1, + "in": "path", + "name": "uid", + "required": true, + "schema": { + "type": "integer", + "x-go-type": "json.Number" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "example": { + "password": "new-single-password" + }, + "schema": { + "$ref": "#/components/schemas/BdbPasswordRequest" + } + } + }, + "description": "New password to set", + "required": true + }, + "responses": { + "200": { + "description": "Password reset successfully" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "406": { + "$ref": "#/components/responses/NotAcceptable" + } + }, + "security": [ + { + "Auth": [ + "update_bdb" + ] + } + ], + "summary": "Reset a database's default user password", + "tags": [ + "Database" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + } + }, + "/v1/cluster/change_password_hashing_algorithm": { + "patch": { + "description": "Change the password hashing algorithm used for all users in the cluster.\nThis will re-hash all existing user passwords with the new algorithm.\n", + "operationId": "cluster_change_cluster_password_hashing_algorithm", + "requestBody": { + "content": { + "application/json": { + "example": { + "algorithm": "PBKDF2" + }, + "schema": { + "$ref": "#/components/schemas/ChangePasswordHashingAlgorithmRequest" + } + } + }, + "description": "Password hashing algorithm change request", + "required": true + }, + "responses": { + "200": { + "description": "Password hashing algorithm changed successfully" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "406": { + "$ref": "#/components/responses/NotAcceptable" + } + }, + "security": [ + { + "Auth": [ + "update_cluster" + ] + } + ], + "summary": "Change the cluster password hashing algorithm", + "tags": [ + "Users" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + } + }, + "/v1/redis_acls": { + "get": { + "description": "Get all Redis ACLs in the cluster", + "operationId": "cluster_get_redis_acls", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/RedisAcl" + }, + "type": "array" + } + } + }, + "description": "List of Redis ACLs" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + } + }, + "security": [ + { + "Auth": [ + "view_all_redis_acls_info" + ] + } + ], + "summary": "Get all Redis ACLs", + "tags": [ + "RedisAcls" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + }, + "post": { + "description": "Create a new Redis ACL with the provided configuration", + "operationId": "cluster_create_redis_acl", + "parameters": [ + { + "allowEmptyValue": true, + "description": "Validate the request without persisting changes", + "in": "query", + "name": "dry_run", + "schema": { + "type": "boolean", + "x-go-type": "DryRun" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RedisAcl" + } + } + }, + "description": "Redis ACL creation data", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RedisAcl" + } + } + }, + "description": "Redis ACL created successfully" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "409": { + "$ref": "#/components/responses/Conflict" + } + }, + "security": [ + { + "Auth": [ + "create_redis_acl" + ] + } + ], + "summary": "Create a new Redis ACL", + "tags": [ + "RedisAcls" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + } + }, + "/v1/redis_acls/validate": { + "post": { + "description": "Validate a Redis ACL without persisting changes. This API route is deprecated (7.12), please use POST /v1/redis_acls?dry_run instead.", + "operationId": "cluster_validate_redis_acl", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RedisAcl" + } + } + }, + "description": "Redis ACL data", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RedisAcl" + } + } + }, + "description": "Redis ACL validated successfully" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "409": { + "$ref": "#/components/responses/Conflict" + } + }, + "security": [ + { + "Auth": [ + "create_redis_acl" + ] + } + ], + "summary": "Validate a Redis ACL", + "tags": [ + "RedisAcls" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + } + }, + "/v1/redis_acls/{uid}": { + "delete": { + "description": "Delete a Redis ACL by unique ID", + "operationId": "cluster_delete_redis_acl", + "parameters": [ + { + "description": "Redis ACL unique ID", + "example": 1, + "in": "path", + "name": "uid", + "required": true, + "schema": { + "type": "integer", + "x-go-type": "json.Number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "action_uid": "12345-abcde-67890" + }, + "properties": { + "action_uid": { + "description": "Action uid for tracking progress", + "type": "string" + } + }, + "type": "object" + } + } + }, + "description": "Redis ACL deleted successfully" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "409": { + "$ref": "#/components/responses/Conflict" + } + }, + "security": [ + { + "Auth": [ + "delete_redis_acl" + ] + } + ], + "summary": "Delete a Redis ACL", + "tags": [ + "RedisAcls" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + }, + "get": { + "description": "Get a single Redis ACL by unique ID", + "operationId": "cluster_get_redis_acl", + "parameters": [ + { + "description": "Redis ACL unique ID", + "example": 1, + "in": "path", + "name": "uid", + "required": true, + "schema": { + "type": "integer", + "x-go-type": "json.Number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RedisAcl" + } + } + }, + "description": "Redis ACL" }, - "role_uids": { - "description": "List of role uids associated with the user", - "items": { + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + } + }, + "security": [ + { + "Auth": [ + "view_redis_acl_info" + ] + } + ], + "summary": "Get a single Redis ACL", + "tags": [ + "RedisAcls" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + }, + "put": { + "description": "Update a Redis ACL by unique ID", + "operationId": "cluster_update_redis_acl", + "parameters": [ + { + "description": "Redis ACL unique ID", + "example": 1, + "in": "path", + "name": "uid", + "required": true, + "schema": { + "type": "integer", + "x-go-type": "json.Number" + } + }, + { + "allowEmptyValue": true, + "description": "Validate the request without persisting changes", + "in": "query", + "name": "dry_run", + "schema": { + "type": "boolean", + "x-go-type": "DryRun" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RedisAcl" + } + } + }, + "description": "Redis ACL update data", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RedisAcl" + } + } + }, + "description": "Redis ACL updated successfully" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "409": { + "$ref": "#/components/responses/Conflict" + } + }, + "security": [ + { + "Auth": [ + "update_redis_acl" + ] + } + ], + "summary": "Update a Redis ACL", + "tags": [ + "RedisAcls" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + } + }, + "/v1/roles": { + "get": { + "description": "Get all Redis Enterprise roles configured in the cluster.", + "operationId": "cluster_get_roles", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Role" + }, + "type": "array" + } + } + }, + "description": "List of roles" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + } + }, + "security": [ + { + "Auth": [ + "view_all_roles_info" + ] + } + ], + "summary": "Get all Redis Enterprise roles", + "tags": [ + "Roles" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + }, + "post": { + "description": "Create a new role with the provided configuration.", + "operationId": "cluster_create_role", + "parameters": [ + { + "allowEmptyValue": true, + "description": "Validate the request without persisting changes.", + "in": "query", + "name": "dry_run", + "schema": { + "type": "boolean", + "x-go-type": "DryRun" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "example": { + "management": "cluster_viewer", + "name": "Support Engineer" + }, + "schema": { + "$ref": "#/components/schemas/RoleCreateRequest" + } + } + }, + "description": "Role creation data.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Role" + } + } + }, + "description": "Role created successfully." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "409": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Role with the same name already exists." + } + }, + "security": [ + { + "Auth": [ + "create_role" + ] + } + ], + "summary": "Create a new Redis Enterprise role", + "tags": [ + "Roles" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + } + }, + "/v1/roles/{uid}": { + "delete": { + "description": "Delete a role by unique ID.", + "operationId": "cluster_delete_role", + "parameters": [ + { + "description": "The role unique ID.", + "example": 17, + "in": "path", + "name": "uid", + "required": true, + "schema": { + "type": "integer", + "x-go-type": "json.Number" + } + }, + { + "allowEmptyValue": true, + "description": "Validate the request without persisting changes.", + "in": "query", + "name": "dry_run", + "schema": { + "type": "boolean", + "x-go-type": "DryRun" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "action_uid": "12345-abcde-67890" + }, + "properties": { + "action_uid": { + "description": "Action uid for tracking progress.", + "type": "string" + } + }, + "type": "object" + } + } + }, + "description": "Role deleted successfully." + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "406": { + "$ref": "#/components/responses/NotAcceptable" + } + }, + "security": [ + { + "Auth": [ + "delete_role" + ] + } + ], + "summary": "Delete a Redis Enterprise role", + "tags": [ + "Roles" + ], + "x-publish-docs": true, + "x-stability-level": "stable" + }, + "get": { + "description": "Get a single role by unique ID.", + "operationId": "cluster_get_role", + "parameters": [ + { + "description": "The role unique ID.", + "example": 17, + "in": "path", + "name": "uid", + "required": true, + "schema": { "type": "integer", "x-go-type": "json.Number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Role" + } + } }, - "type": "array" + "description": "Role information." }, - "status": { - "description": "Status of the user.", - "enum": [ - "active", - "locked", - "password_expired" - ], - "type": "string" + "403": { + "$ref": "#/components/responses/Forbidden" }, - "uid": { - "description": "User's unique uid.", - "type": "integer", - "x-go-type": "json.Number" + "404": { + "$ref": "#/components/responses/NotFound" } }, - "required": [ - "uid", - "name", - "role", - "role_uids", - "auth_method" + "security": [ + { + "Auth": [ + "view_role_info" + ] + } ], - "type": "object" + "summary": "Get a single Redis Enterprise role", + "tags": [ + "Roles" + ], + "x-publish-docs": true, + "x-stability-level": "stable" }, - "UserRequest": { - "description": "User modification request.", - "properties": { - "account_id": { - "description": "SM account ID", - "type": "integer" + "put": { + "description": "Update a role configuration by unique ID.", + "operationId": "cluster_update_role", + "parameters": [ + { + "description": "The role unique ID.", + "example": 17, + "in": "path", + "name": "uid", + "required": true, + "schema": { + "type": "integer", + "x-go-type": "json.Number" + } }, - "auth_method": { - "enum": [ - "regular", - "certificate", - "entraid", - "sso" - ], - "type": "string" + { + "allowEmptyValue": true, + "description": "Validate the request without persisting changes.", + "in": "query", + "name": "dry_run", + "schema": { + "type": "boolean", + "x-go-type": "DryRun" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "example": { + "management": "cluster_member" + }, + "schema": { + "$ref": "#/components/schemas/RoleUpdateRequest" + } + } }, - "bdbs_email_alerts": { - "description": "UIDs of databases that user will receive alerts for.", - "items": { - "type": "string" + "description": "Role update data.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Role" + } + } }, - "type": "array", - "uniqueItems": true - }, - "certificate_subject_line": { - "description": "The certificate's subject line as defined by RFC2253 (for certificate based authentication users only)", - "type": "string" + "description": "Role updated successfully." }, - "cluster_email_alerts": { - "description": "Activate cluster email alerts for a user.", - "type": "boolean" - }, - "email": { - "description": "User's email.", - "pattern": "(^$|^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$)", - "type": "string" - }, - "email_alerts": { - "description": "Activate email alerts for a user.", - "type": "boolean" - }, - "name": { - "description": "User's name. (pattern does not allow non ascii and special characters \u0026,\u003c,\u003e,\")", - "maxLength": 255, - "minLength": 1, - "pattern": "^[ -!#-%'-;=?-~]+$", - "type": "string" - }, - "password": { - "description": "User's password for regular authentication. Required for regular auth method.", - "type": "string" + "400": { + "$ref": "#/components/responses/BadRequest" }, - "password_hash_method": { - "$ref": "#/components/schemas/PasswordHashMethod" + "403": { + "$ref": "#/components/responses/Forbidden" }, - "role": { - "allOf": [ - { - "$ref": "#/components/schemas/RoleName" - } - ], - "deprecated": true, - "description": "(deprecated) User's role.", - "x-deprecated-reason": "Use role_uids instead", - "x-sunset": "2027-12-31" + "404": { + "$ref": "#/components/responses/NotFound" }, - "role_uids": { - "description": "List of role uids associated with the user", - "items": { - "type": "integer", - "x-go-type": "json.Number" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true + "406": { + "$ref": "#/components/responses/NotAcceptable" }, - "uid": { - "description": "User's unique uid.", - "minimum": 1, - "type": "integer", - "x-go-type": "json.Number" + "409": { + "$ref": "#/components/responses/Conflict" } }, - "type": "object" + "security": [ + { + "Auth": [ + "update_role" + ] + } + ], + "summary": "Update a Redis Enterprise role", + "tags": [ + "Roles" + ], + "x-publish-docs": true, + "x-stability-level": "stable" } }, - "securitySchemes": { - "Auth": { - "in": "header", - "name": "r-auth-user", - "type": "apiKey" - }, - "auth": { - "in": "header", - "name": "Authorization", - "type": "apiKey" - } - } - }, - "info": { - "description": "Redis Enterprise Software REST API reference. This API reference is still a work in progress. For more API paths, see the [REST API requests](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/) reference pages.", - "title": "Redis Enterprise Software REST API", - "version": "1.0.0" - }, - "openapi": "3.0.0", - "paths": { "/v1/users": { "get": { "description": "Get all Redis Enterprise Cluster users in the cluster", @@ -977,6 +2649,107 @@ "x-publish-docs": true, "x-stability-level": "stable" } + }, + "/v4/cluster/health": { + "get": { + "description": "Cluster health report.", + "operationId": "cluster_cluster_health_report", + "parameters": [ + { + "description": "indicate to return only resources with unhealthy status", + "in": "query", + "name": "issues_only", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClusterHealthReport" + } + } + }, + "description": "Cluster report is ready see detailed information." + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "503": { + "$ref": "#/components/responses/ServiceUnavailable" + } + }, + "security": [ + { + "Auth": [ + "view_cluster_info" + ] + } + ], + "summary": "Get cluster health report.", + "tags": [ + "Cluster" + ], + "x-publish-docs": true + } + }, + "/v4/db/{db_id}/health": { + "get": { + "description": "Database health check indication.", + "operationId": "cluster_database_health_report", + "parameters": [ + { + "description": "database ID", + "in": "path", + "name": "db_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "indicate to return only resources with unhealthy status", + "in": "query", + "name": "issues_only", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseHealthReport" + } + } + }, + "description": "Database report is ready see detailed information." + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "503": { + "$ref": "#/components/responses/ServiceUnavailable" + } + }, + "security": [ + { + "Auth": [ + "view_bdb_info" + ] + } + ], + "summary": "Get database health report.", + "tags": [ + "Database" + ], + "x-publish-docs": true + } } }, "servers": [ From b388edb64416aadfc7fcf7374fb42cb5622ed181 Mon Sep 17 00:00:00 2001 From: "redis-enterprise-doc-sync[bot]" <246451900+redis-enterprise-doc-sync[bot]@users.noreply.github.com> Date: Tue, 3 Feb 2026 06:16:09 +0000 Subject: [PATCH 2/3] Update Redis Enterprise API specification --- .../rest-api/api-reference/openapi.json | 20 ++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/content/operate/rs/references/rest-api/api-reference/openapi.json b/content/operate/rs/references/rest-api/api-reference/openapi.json index 529e702f8f..cfeee9b9a7 100644 --- a/content/operate/rs/references/rest-api/api-reference/openapi.json +++ b/content/operate/rs/references/rest-api/api-reference/openapi.json @@ -94,6 +94,10 @@ "description": "Alert name", "type": "string" }, + "severity": { + "description": "Severity level of the alert", + "type": "string" + }, "threshold": { "description": "Threshold for the alert", "type": "string" @@ -499,6 +503,12 @@ "Node": { "description": "Node information.", "properties": { + "active_alerts": { + "items": { + "$ref": "#/components/schemas/Alert" + }, + "type": "array" + }, "detailed_status": { "description": "Node detailed status", "enum": [ @@ -883,18 +893,18 @@ "StateMachine": { "description": "State machine information", "properties": { - "actions": { - "description": "State machine actions", - "type": "string" - }, "name": { "description": "State machine name", "type": "string" + }, + "state": { + "description": "State machine state", + "type": "string" } }, "required": [ "name", - "actions" + "state" ], "type": "object" }, From 4410f4c99e4108285204a3ece3ba43918a5e989f Mon Sep 17 00:00:00 2001 From: "redis-enterprise-doc-sync[bot]" <246451900+redis-enterprise-doc-sync[bot]@users.noreply.github.com> Date: Sat, 7 Feb 2026 06:11:37 +0000 Subject: [PATCH 3/3] Update Redis Enterprise API specification --- .../rest-api/api-reference/openapi.json | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/content/operate/rs/references/rest-api/api-reference/openapi.json b/content/operate/rs/references/rest-api/api-reference/openapi.json index cfeee9b9a7..d6c3192013 100644 --- a/content/operate/rs/references/rest-api/api-reference/openapi.json +++ b/content/operate/rs/references/rest-api/api-reference/openapi.json @@ -720,9 +720,9 @@ "type": "object" } ], - "description": "An API object that represents a Redis Enterprise role.", + "description": "An API object that represents a Redis Software role.", "example": { - "management": "admin", + "management": "cluster_member", "name": "DBA", "uid": 1 } @@ -909,7 +909,7 @@ "type": "object" }, "User": { - "description": "An API object that represents an Redis Enterprise Cluster user.", + "description": "An API object that represents an Redis Software Cluster user.", "example": { "auth_method": "regular", "email": "user@redis.com", @@ -1166,8 +1166,8 @@ } }, "info": { - "description": "Redis Enterprise Software REST API reference. This API reference is still a work in progress. For more API paths, see the [REST API requests](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/) reference pages.", - "title": "Redis Enterprise Software REST API", + "description": "Redis Software REST API reference. This API reference is still a work in progress. For more API paths, see the [REST API requests](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/) reference pages.", + "title": "Redis Software REST API", "version": "1.0.0" }, "openapi": "3.0.0", @@ -1722,7 +1722,7 @@ }, "/v1/roles": { "get": { - "description": "Get all Redis Enterprise roles configured in the cluster.", + "description": "Get all Redis Software roles configured in the cluster.", "operationId": "cluster_get_roles", "responses": { "200": { @@ -1749,7 +1749,7 @@ ] } ], - "summary": "Get all Redis Enterprise roles", + "summary": "Get all Redis Software roles", "tags": [ "Roles" ], @@ -1821,7 +1821,7 @@ ] } ], - "summary": "Create a new Redis Enterprise role", + "summary": "Create a new Redis Software role", "tags": [ "Roles" ], @@ -1893,7 +1893,7 @@ ] } ], - "summary": "Delete a Redis Enterprise role", + "summary": "Delete a Redis Software role", "tags": [ "Roles" ], @@ -1941,7 +1941,7 @@ ] } ], - "summary": "Get a single Redis Enterprise role", + "summary": "Get a single Redis Software role", "tags": [ "Roles" ], @@ -2022,7 +2022,7 @@ ] } ], - "summary": "Update a Redis Enterprise role", + "summary": "Update a Redis Software role", "tags": [ "Roles" ], @@ -2032,7 +2032,7 @@ }, "/v1/users": { "get": { - "description": "Get all Redis Enterprise Cluster users in the cluster", + "description": "Get all Redis Software users in the cluster", "operationId": "cluster_get_users", "responses": { "200": { @@ -2059,7 +2059,7 @@ ] } ], - "summary": "Get all Redis Enterprise Cluster users", + "summary": "Get all Redis Software users", "tags": [ "Users" ], @@ -2127,7 +2127,7 @@ ] } ], - "summary": "Create a new Redis Enterprise Cluster user", + "summary": "Create a new Redis Software user", "tags": [ "Users" ], @@ -2529,7 +2529,7 @@ ] } ], - "summary": "Delete a Redis Enterprise Cluster user", + "summary": "Delete a Redis Software user", "tags": [ "Users" ], @@ -2575,7 +2575,7 @@ "Auth": [] } ], - "summary": "Get a single Redis Enterprise Cluster user", + "summary": "Get a single Redis Software user", "tags": [ "Users" ], @@ -2652,7 +2652,7 @@ "Auth": [] } ], - "summary": "Update a Redis Enterprise Cluster user", + "summary": "Update a Redis Software user", "tags": [ "Users" ],