diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index db58a6172c..0943760901 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -28,7 +28,7 @@ "tags": [ { "name": "Account", - "description": "Current account and ownership information", + "description": "Current account details.", "x-order": "0" }, { @@ -57,13 +57,13 @@ "x-order": "40" }, { - "name": "Access Control List", - "description": "Data and operations related to access control list", + "name": "Role-based Access Control (RBAC)", + "description": "All operations for [Role-based Access Control](https://redis.io/docs/latest/operate/rc/security/access-control/data-access-control/role-based-access-control/) (RBAC).", "x-order": "50" }, { "name": "Cloud Accounts", - "description": "All operations related to cloud accounts (AWS only)", + "description": "All operations related to cloud accounts (AWS only).", "x-order": "60" }, { @@ -73,7 +73,7 @@ }, { "name": "Tasks", - "description": "Displays information on long running operations", + "description": "Tracks asynchronous background operations. See [API request lifecycle](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) for more information.", "x-order": "80" } ], @@ -83,14 +83,14 @@ "tags": [ "Users" ], - "summary": "Get user by id", - "description": "Information on user identified by user Id", + "summary": "Get a single user", + "description": "Gets details about a single account user.", "operationId": "getUserById", "parameters": [ { "name": "userId", "in": "path", - "description": "User Id", + "description": "User ID.", "required": true, "schema": { "type": "integer", @@ -139,14 +139,14 @@ "tags": [ "Users" ], - "summary": "Update user", - "description": "Update an existing user by Id", + "summary": "Update a user", + "description": "Updates an account user's name or role.", "operationId": "updateUser", "parameters": [ { "name": "userId", "in": "path", - "description": "User Id", + "description": "User ID.", "required": true, "schema": { "type": "integer", @@ -212,13 +212,13 @@ "Users" ], "summary": "Delete user", - "description": "Delete a user from current account", + "description": "Deletes a user from this account.", "operationId": "deleteUserById", "parameters": [ { "name": "userId", "in": "path", - "description": "User Id", + "description": "User ID.", "required": true, "schema": { "type": "integer", @@ -3913,8 +3913,8 @@ "tags": [ "Cloud Accounts" ], - "summary": "Get cloud account by id", - "description": "Information on a specific cloud account", + "summary": "Get a single cloud account", + "description": "Gets details on a single cloud account.", "operationId": "getCloudAccountById", "parameters": [ { @@ -3971,7 +3971,7 @@ "Cloud Accounts" ], "summary": "Update cloud account", - "description": "Update cloud account", + "description": "Updates cloud account details.", "operationId": "updateCloudAccount", "parameters": [ { @@ -4044,7 +4044,7 @@ "Cloud Accounts" ], "summary": "Delete cloud account", - "description": "Delete specified cloud account", + "description": "Deletes a cloud account.", "operationId": "deleteCloudAccount", "parameters": [ { @@ -4106,16 +4106,16 @@ "/acl/users/{aclUserId}": { "get": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Get ACL user by id", - "description": "Information on an ACL user identified by ACL user Id", + "summary": "Get a single access control user", + "description": "Gets details and settings for single access control user.", "operationId": "getUserByID", "parameters": [ { "name": "aclUserId", "in": "path", - "description": "ACL user ID", + "description": "Access control user ID.", "required": true, "schema": { "minimum": 0, @@ -4163,16 +4163,16 @@ }, "put": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Update ACL user", - "description": "Update a new ACL user", + "summary": "Update access control user", + "description": "Updates a access control user with a different role or database password.", "operationId": "updateUser_1", "parameters": [ { "name": "aclUserId", "in": "path", - "description": "ACL user ID", + "description": "Access control user ID.", "required": true, "schema": { "type": "integer", @@ -4235,16 +4235,16 @@ }, "delete": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Delete ACL user", - "description": "Delete an ACL user", + "summary": "Delete access control user", + "description": "Deletes a access control user.", "operationId": "deleteUser", "parameters": [ { "name": "aclUserId", "in": "path", - "description": "ACL user ID", + "description": "Access control user ID.", "required": true, "schema": { "type": "integer", @@ -4299,16 +4299,16 @@ "/acl/roles/{aclRoleId}": { "put": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Update ACL role", - "description": "Update an ACL role", + "summary": "Update database access role", + "description": "Updates a database access role with new assigned permissions or associated databases.", "operationId": "updateRole", "parameters": [ { "name": "aclRoleId", "in": "path", - "description": "ACL role ID", + "description": "Database access role ID.", "required": true, "schema": { "type": "integer", @@ -4371,16 +4371,16 @@ }, "delete": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Delete ACL role", - "description": "Delete an ACL role", + "summary": "Delete database access role", + "description": "Deletes a database access role.", "operationId": "deleteAclRole", "parameters": [ { "name": "aclRoleId", "in": "path", - "description": "ACL role ID", + "description": "Database access role ID.", "required": true, "schema": { "type": "integer", @@ -4435,16 +4435,16 @@ "/acl/redisRules/{aclRedisRuleId}": { "put": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Update ACL redis rule", - "description": "Update an ACL redis rule", + "summary": "Update Redis ACL rule", + "description": "Updates a Redis ACL rule.", "operationId": "updateRedisRule", "parameters": [ { "name": "aclRedisRuleId", "in": "path", - "description": "ACL redis rule ID", + "description": "Redis ACL rule ID.", "required": true, "schema": { "type": "integer", @@ -4507,16 +4507,16 @@ }, "delete": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Delete ACL redis rule", - "description": "Delete an ACL redis rule", + "summary": "Delete Redis ACL rule", + "description": "Deletes a Redis ACL rule.", "operationId": "deleteRedisRule", "parameters": [ { "name": "aclRedisRuleId", "in": "path", - "description": "ACL redis rule ID", + "description": "Redis ACL rule ID.", "required": true, "schema": { "type": "integer", @@ -5372,7 +5372,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Create Active-Active VPC peering", - "description": "(Active-Active subscriptions only) Sets up VPC peering for an Active-Active subscription. \nEnsure your cloud provider is also set up for VPC Peering with Redis Cloud. See [VPC Peering](https://docs.redis.com/latest/rc/security/vpc-peering) to learn how to set up VPC Peering with AWS and Google Cloud.", + "description": "(Active-Active subscriptions only) Sets up VPC peering for an Active-Active subscription. Ensure your cloud provider is also set up for VPC Peering with Redis Cloud. See [VPC Peering](https://docs.redis.com/latest/rc/security/vpc-peering) to learn how to set up VPC Peering with AWS and Google Cloud.", "operationId": "createActiveActiveVpcPeering", "parameters": [ { @@ -5853,7 +5853,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Create VPC peering", - "description": "Sets up VPC peering for the specified subscription. \nEnsure your cloud provider is also set up for VPC Peering with Redis Cloud. See [VPC Peering](https://docs.redis.com/latest/rc/security/vpc-peering) to learn how to set up VPC Peering with AWS and Google Cloud.", + "description": "Sets up VPC peering for the specified subscription. Ensure your cloud provider is also set up for VPC Peering with Redis Cloud. See [VPC Peering](https://docs.redis.com/latest/rc/security/vpc-peering) to learn how to set up VPC Peering with AWS and Google Cloud.", "operationId": "createVpcPeering", "parameters": [ { @@ -7150,7 +7150,7 @@ "Cloud Accounts" ], "summary": "Get cloud accounts", - "description": "List all configured cloud accounts", + "description": "Gets a list of all configured cloud accounts.", "operationId": "getCloudAccounts", "responses": { "400": { @@ -7194,7 +7194,7 @@ "Cloud Accounts" ], "summary": "Create cloud account", - "description": "Create cloud account", + "description": "Creates a cloud account.", "operationId": "createCloudAccount", "requestBody": { "content": { @@ -7256,10 +7256,10 @@ "/acl/users": { "get": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Get ACL users", - "description": "Information on current account's ACL users", + "summary": "Get access control users", + "description": "Gets a list of all access control users for this account.", "operationId": "getAllUsers_1", "responses": { "400": { @@ -7300,10 +7300,10 @@ }, "post": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Create ACL user", - "description": "Create a new ACL user", + "summary": "Create access control user", + "description": "Creates a new access control user with the assigned database access role.", "operationId": "createUser", "requestBody": { "content": { @@ -7365,10 +7365,10 @@ "/acl/roles": { "get": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Get ACL roles", - "description": "Information on current account's ACL roles", + "summary": "Get database access roles", + "description": "Gets a list of all database access roles for this account.", "operationId": "getRoles", "responses": { "400": { @@ -7409,10 +7409,10 @@ }, "post": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Create ACL role", - "description": "Create a new ACL role", + "summary": "Create database access role", + "description": "Creates a new database access role with the assigned permissions and associates it with the provided databases.", "operationId": "createRole", "requestBody": { "content": { @@ -7474,10 +7474,10 @@ "/acl/redisRules": { "get": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Get ACL redis rules", - "description": "Information on current account's ACL users", + "summary": "Get Redis ACL rules", + "description": "Gets a list of all Redis ACL rules for this account.", "operationId": "getAllRedisRules", "responses": { "400": { @@ -7518,10 +7518,10 @@ }, "post": { "tags": [ - "Access Control List" + "Role-based Access Control (RBAC)" ], - "summary": "Create ACL redis rule", - "description": "Create a new ACL redis rule", + "summary": "Create Redis ACL rule", + "description": "Creates a new Redis ACL rule.", "operationId": "createRedisRule", "requestBody": { "content": { @@ -7586,7 +7586,7 @@ "Users" ], "summary": "Get users", - "description": "Information on current account's users", + "description": "Gets a list of all account users.", "operationId": "getAllUsers", "responses": { "400": { @@ -7632,7 +7632,7 @@ "Tasks" ], "summary": "Get tasks", - "description": "Currently active long running operations", + "description": "Gets a list of all currently running tasks for this account.", "operationId": "getAllTasks", "responses": { "400": { @@ -7677,14 +7677,14 @@ "tags": [ "Tasks" ], - "summary": "Get task by id", - "description": "Get specific long running operation, identified by Task Id", + "summary": "Get a single task", + "description": "Gets details and status of a single task by the Task ID.", "operationId": "getTaskById", "parameters": [ { "name": "taskId", "in": "path", - "description": "Task Id", + "description": "Task ID.", "required": true, "schema": { "type": "string" @@ -8373,6 +8373,83 @@ } } }, + "/subscriptions/{subscriptionId}/databases/{databaseId}/slow-log": { + "get": { + "tags": [ + "Databases - Pro" + ], + "summary": "Get database slowlog", + "description": "Gets the slowlog for a specific database.", + "operationId": "getSlowLog", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription ID.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "databaseId", + "in": "path", + "description": "Database ID.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "regionName", + "in": "query", + "description": "Region name - required for Active-Active subscription", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, + "412": { + "description": "Precondition Failed - Feature flag for this flow is off" + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseSlowLogEntries" + } + } + } + }, + "401": { + "description": "Unauthorized - Authentication failed for requested resource" + }, + "403": { + "description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)" + }, + "404": { + "description": "Not Found - The resource you were trying to reach was not found or does not exist" + }, + "429": { + "description": "Too Many Requests - Too many resources are concurrently created / updated / deleted in the account. Please re-submit API requests after resource changes are completed)" + }, + "500": { + "description": "Internal system error - If this error persists, please contact customer support" + }, + "503": { + "description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support " + } + } + } + }, "/subscriptions/{subscriptionId}/databases/{databaseId}/certificate": { "get": { "tags": [ @@ -8494,8 +8571,8 @@ "tags": [ "Account" ], - "summary": "Get session log", - "description": "Session log information for current account", + "summary": "Get session logs", + "description": "Gets session logs for this account.", "operationId": "getAccountSessionLogs", "parameters": [ { @@ -8512,7 +8589,7 @@ { "name": "limit", "in": "query", - "description": "Maximum number of items to return, but not more than 100", + "description": "Maximum number of logs to return. Limit: 100", "required": false, "schema": { "maximum": 100, @@ -8566,14 +8643,14 @@ "tags": [ "Account" ], - "summary": "Get Pro plans regions", - "description": "Lookup list of regions for cloud provider", + "summary": "Get available Pro plan regions", + "description": "Gets a list of available regions for Pro subscriptions. For Essentials subscriptions, use 'GET /fixed/plans'.", "operationId": "getSupportedRegions", "parameters": [ { "name": "provider", "in": "query", - "description": "Provider Name", + "description": "Filters results to the specified cloud provider.", "required": false, "schema": { "type": "string", @@ -8627,8 +8704,8 @@ "tags": [ "Account" ], - "summary": "Get Query performance factors", - "description": "Lookup list of supported Query performance factors", + "summary": "Get query performance factors", + "description": "Gets a list of available [query performance factors](https://redis.io/docs/latest/operate/rc/databases/configuration/advanced-capabilities/#query-performance-factor).", "operationId": "getSupportedSearchScalingFactors", "responses": { "400": { @@ -8674,7 +8751,7 @@ "Account" ], "summary": "Get payment methods", - "description": "Lookup list of current Account's payment methods", + "description": "Gets a list of all payment methods for this account.", "operationId": "getAccountPaymentMethods", "responses": { "400": { @@ -8719,8 +8796,8 @@ "tags": [ "Account" ], - "summary": "Get system log", - "description": "System log information for current account", + "summary": "Get system logs", + "description": "Gets [system logs](https://redis.io/docs/latest/operate/rc/api/examples/audit-system-logs/) for this account.", "operationId": "getAccountSystemLogs", "parameters": [ { @@ -8737,7 +8814,7 @@ { "name": "limit", "in": "query", - "description": "Maximum number of items to return, but not more than 1000", + "description": "Maximum number of logs to return. Limit: 1000", "required": false, "schema": { "maximum": 1000, @@ -8786,13 +8863,81 @@ } } }, + "/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/slow-log": { + "get": { + "tags": [ + "Databases - Essentials" + ], + "summary": "Get Essentials database slow-log by database id", + "description": "Get slow-log for a specific database identified by Essentials subscription Id and database Id", + "operationId": "getSlowLog_1", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription ID.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "databaseId", + "in": "path", + "description": "Database ID.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, + "412": { + "description": "Precondition Failed - Feature flag for this flow is off" + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseSlowLogEntries" + } + } + } + }, + "401": { + "description": "Unauthorized - Authentication failed for requested resource" + }, + "403": { + "description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)" + }, + "404": { + "description": "Not Found - The resource you were trying to reach was not found or does not exist" + }, + "429": { + "description": "Too Many Requests - Too many resources are concurrently created / updated / deleted in the account. Please re-submit API requests after resource changes are completed)" + }, + "500": { + "description": "Internal system error - If this error persists, please contact customer support" + }, + "503": { + "description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support " + } + } + } + }, "/fixed/plans": { "get": { "tags": [ "Subscriptions - Essentials" ], "summary": "Get Essentials plans", - "description": "Gets a list of Essentials plans.", + "description": "Gets a list of Essentials plans. The plan describes the dataset size, cloud provider and region, and available database configuration options for an Essentials database.", "operationId": "getAllFixedSubscriptionsPlans", "parameters": [ { @@ -8978,8 +9123,8 @@ "tags": [ "Account" ], - "summary": "Get modules", - "description": "Lookup list of database modules supported in current account (support may differ based on subscription and database settings)", + "summary": "Get advanced capabilities", + "description": "Gets a list of Redis [advanced capabilities](https://redis.io/docs/latest/operate/rc/databases/configuration/advanced-capabilities/) (also known as modules) available for this account. Advanced capability support may differ based on subscription and database settings.", "operationId": "getSupportedDatabaseModules", "responses": { "400": { @@ -9024,8 +9169,8 @@ "tags": [ "Account" ], - "summary": "Get list of data persistence options", - "description": "Lookup list of data persistence values", + "summary": "Get data persistence options", + "description": "Gets a list of all [data persistence](https://redis.io/docs/latest/operate/rc/databases/configuration/data-persistence/) options for this account.", "operationId": "getDataPersistenceOptions", "responses": { "400": { @@ -9070,8 +9215,8 @@ "tags": [ "Account" ], - "summary": "Get current Account", - "description": "Current account and related information", + "summary": "Get current account", + "description": "Gets information on this account.", "operationId": "getCurrentAccount", "responses": { "400": { @@ -9124,17 +9269,17 @@ "properties": { "name": { "type": "string", - "description": "Required. ACL user name", + "description": "Access control user name.", "example": "ACL-user-example" }, "role": { "type": "string", - "description": "Required. ACL role name", + "description": "Name of the database access role to assign to this user. Use GET '/acl/roles' to get a list of database access roles.", "example": "Redis-role-example" }, "password": { "type": "string", - "description": "Required. Password to identify as user after creation.", + "description": "The database password for this user.", "example": "some-random-password" }, "commandType": { @@ -9157,12 +9302,12 @@ }, "name": { "type": "string", - "description": "User name", + "description": "The account user's name.", "example": "My new user name" }, "role": { "type": "string", - "description": "Role name", + "description": "Changes the account user's role. See [Team management roles](https://redis.io/docs/latest/operate/rc/security/access-control/access-management/#team-management-roles) to learn about available account roles.", "enum": [ "Owner", "Member", @@ -9246,26 +9391,26 @@ "properties": { "subscriptionId": { "type": "integer", - "description": "Required. Subscription Id of the given database", + "description": "Subscription ID for the database's subscription. Use 'GET /subscriptions' or 'GET /fixed/subscriptions' to get a list of available subscriptions and their IDs.", "format": "int32" }, "databaseId": { "type": "integer", - "description": "Required. Database Id that belong to the subscription", + "description": "The database's ID. Use 'GET /subscriptions/{subscriptionId}/databases' or 'GET /fixed/subscriptions/{subscriptionId}/databases' to get a list of databases in a subscription and their IDs.", "format": "int32" }, "regions": { "type": "array", - "description": "Optional. AA regions name belong to the given database, list of String comma separated", + "description": "(Active-Active databases only) Optional. A list of regions where this rule applies for this role.", "example": [], "items": { "type": "string", - "description": "Optional. AA regions name belong to the given database, list of String comma separated", + "description": "(Active-Active databases only) Optional. A list of regions where this rule applies for this role.", "example": "[]" } } }, - "description": "Required. List of databaseId and subscriptionId pairs associated with the requested ACL role" + "description": "A list of databases where the specified rule applies for this role." }, "ActiveActiveTgwUpdateCidrsRequest": { "type": "object", @@ -9403,7 +9548,7 @@ }, "paymentMethodId": { "type": "integer", - "description": "Optional. The payment method ID you'd like to use for this subscription. Must be a valid payment method ID for this account. Use GET /payment-methods to view all payment methods for your account. \nThis value is optional if ‘paymentMethod’ is ‘marketplace’, but required if 'paymentMethod' is 'credit-card'.", + "description": "Optional. The payment method ID you'd like to use for this subscription. Must be a valid payment method ID for this account. Use GET /payment-methods to get all payment methods for your account. This value is optional if ‘paymentMethod’ is ‘marketplace’, but required if 'paymentMethod' is 'credit-card'.", "format": "int32" }, "paymentMethod": { @@ -9653,7 +9798,7 @@ "properties": { "name": { "type": "string", - "description": "Name of the database. \nDatabase name is limited to 40 characters or less and must include only letters, digits, and hyphens ('-'). It must start with a letter and end with a letter or digit.", + "description": "Name of the database. Database name is limited to 40 characters or less and must include only letters, digits, and hyphens ('-'). It must start with a letter and end with a letter or digit.", "example": "Redis-database-example" }, "protocol": { @@ -9677,7 +9822,7 @@ "minimum": 0.1, "exclusiveMinimum": false, "type": "number", - "description": "Optional. The maximum amount of data in the dataset for this database in GB. You cannot set both datasetSizeInGb and totalMemoryInGb. \nIf ‘replication’ is 'true', the database’s total memory will be twice as large as the datasetSizeInGb.If ‘replication’ is false, the database’s total memory will be the datasetSizeInGb value.", + "description": "Optional. The maximum amount of data in the dataset for this database in GB. You cannot set both datasetSizeInGb and totalMemoryInGb. If ‘replication’ is 'true', the database’s total memory will be twice as large as the datasetSizeInGb.If ‘replication’ is false, the database’s total memory will be the datasetSizeInGb value.", "format": "double", "example": 1 }, @@ -9714,7 +9859,7 @@ }, "modules": { "type": "array", - "description": "Optional. Redis advanced capabilities (also known as modules) to be provisioned in the database. \nUse GET /database-modules to view a list of available advanced capabilities.", + "description": "Optional. Redis advanced capabilities (also known as modules) to be provisioned in the database. Use GET /database-modules to get a list of available advanced capabilities.", "items": { "$ref": "#/components/schemas/DatabaseModuleSpec" } @@ -9804,6 +9949,15 @@ "type": "object" } } + }, + "persistentStorageEncryptionType": { + "type": "string" + }, + "deletionGracePeriod": { + "type": "string" + }, + "customerManagedKeyAccessDetails": { + "$ref": "#/components/schemas/CustomerManagedKeyAccessDetails" } }, "description": "RedisLabs Subscription information", @@ -10055,7 +10209,7 @@ }, "modules": { "type": "array", - "description": "Optional. Redis advanced capabilities (also known as modules) to be provisioned in the database. Use GET /database-modules to view a list of available advanced capabilities. Can only be set if 'protocol' is 'redis'.", + "description": "Optional. Redis advanced capabilities (also known as modules) to be provisioned in the database. Use GET /database-modules to get a list of available advanced capabilities. Can only be set if 'protocol' is 'redis'.", "items": { "$ref": "#/components/schemas/DatabaseModuleSpec" } @@ -10103,7 +10257,7 @@ "minimum": 0.1, "exclusiveMinimum": false, "type": "number", - "description": "Optional. The maximum amount of data in the dataset for this database in GB. You cannot set both datasetSizeInGb and totalMemoryInGb. \nIf ‘replication’ is 'true', the database’s total memory will be twice as large as the datasetSizeInGb.If ‘replication’ is false, the database’s total memory will be the datasetSizeInGb value.", + "description": "Optional. The maximum amount of data in the dataset for this database in GB. You cannot set both datasetSizeInGb and totalMemoryInGb. If ‘replication’ is 'true', the database’s total memory will be twice as large as the datasetSizeInGb.If ‘replication’ is false, the database’s total memory will be the datasetSizeInGb value.", "format": "double", "example": 1 }, @@ -10879,7 +11033,7 @@ "properties": { "endpoint": { "type": "string", - "description": "Redis URI of a source database. Example format: 'redis://user:password@host:port'. \nIf the URI provided is a Redis Cloud database, only host and port should be provided. Example: 'redis://endpoint1:6379'." + "description": "Redis URI of a source database. Example format: 'redis://user:password@host:port'. If the URI provided is a Redis Cloud database, only host and port should be provided. Example: 'redis://endpoint1:6379'." }, "encryption": { "type": "boolean", @@ -10940,12 +11094,12 @@ }, "name": { "type": "string", - "description": "Optional. ACL redis rule name", + "description": "Optional. Changes the Redis ACL rule name.", "example": "ACL-rule-example" }, "redisRule": { "type": "string", - "description": "Optional. ACL redis rule pattern" + "description": "Optional. Changes the Redis ACL rule pattern. See [ACL syntax](https://redis.io/docs/latest/operate/rc/security/access-control/data-access-control/configure-acls/#define-permissions-with-acl-syntax) to learn how to define rules." }, "commandType": { "type": "string", @@ -11055,7 +11209,7 @@ }, "paymentMethodId": { "type": "integer", - "description": "Optional. The payment method ID you'd like to use for this subscription. Must be a valid payment method ID for this account. Use GET /payment-methods to view all payment methods for your account. This value is optional if ‘paymentMethod’ is ‘marketplace’, but required if 'paymentMethod' is 'credit-card'.", + "description": "Optional. The payment method ID you'd like to use for this subscription. Must be a valid payment method ID for this account. Use GET /payment-methods to get a list of payment methods for your account. This value is optional if ‘paymentMethod’ is ‘marketplace’, but required if 'paymentMethod' is 'credit-card'.", "format": "int32" }, "commandType": { @@ -11786,12 +11940,12 @@ "properties": { "name": { "type": "string", - "description": "Optional. ACL role name", + "description": "Optional. Changes the database access role name.", "example": "ACL-role-example" }, "redisRules": { "type": "array", - "description": "Optional. List of ACL redis rules to associated with the requested ACL role", + "description": "Optional. Changes the Redis ACL rules to assign to this database access role.", "items": { "$ref": "#/components/schemas/AclRoleRedisRuleSpec" } @@ -11961,6 +12115,27 @@ } } }, + "CustomerManagedKeyAccessDetails": { + "type": "object", + "properties": { + "redisServiceAccount": { + "type": "string" + }, + "googlePredefinedRoles": { + "type": "array", + "items": { + "type": "string" + } + }, + "googleCustomPermissions": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Configuration regarding customer managed persistent storage encryption" + }, "SubscriptionMaintenanceWindowsSpec": { "required": [ "mode" @@ -12362,7 +12537,7 @@ "properties": { "name": { "type": "string", - "description": "Required. Cloud account display name", + "description": "Cloud account display name.", "example": "My new Cloud Account" }, "provider": { @@ -12376,27 +12551,27 @@ }, "accessKeyId": { "type": "string", - "description": "Required. Cloud provider access key", + "description": "Cloud provider access key.", "example": "****" }, "accessSecretKey": { "type": "string", - "description": "Required. Cloud provider secret key", + "description": "Cloud provider secret key.", "example": "****" }, "consoleUsername": { "type": "string", - "description": "Required. Cloud provider management console username", + "description": "Cloud provider management console username.", "example": "me@mycompany.com" }, "consolePassword": { "type": "string", - "description": "Required. Cloud provider management console password", + "description": "Cloud provider management console password.", "example": "****" }, "signInLoginUrl": { "type": "string", - "description": "Required. Cloud provider management console login URL", + "description": "Cloud provider management console login URL.", "example": "https://.signin.aws.amazon.com/console" }, "commandType": { @@ -12529,18 +12704,18 @@ "properties": { "ruleName": { "type": "string", - "description": "Required. ACL redis rule name", + "description": "The name of a Redis ACL rule to assign to the role. Use 'GET /acl/redisRules' to get a list of available rules for your account.", "example": "Read-Only" }, "databases": { "type": "array", - "description": "Required. List of databaseId and subscriptionId pairs associated with the requested ACL role", + "description": "A list of databases where the specified rule applies for this role.", "items": { "$ref": "#/components/schemas/AclRoleDatabaseSpec" } } }, - "description": "Optional. List of ACL redis rules to associated with the requested ACL role" + "description": "Optional. Changes the Redis ACL rules to assign to this database access role." }, "ActiveActiveSubscriptionRegions": { "type": "object", @@ -12926,6 +13101,47 @@ }, "description": "Private Service Connect endpoint update request" }, + "DatabaseSlowLogEntries": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DatabaseSlowLogEntry" + } + }, + "links": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + } + }, + "DatabaseSlowLogEntry": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "startTime": { + "type": "string", + "format": "date-time" + }, + "duration": { + "type": "integer", + "format": "int32" + }, + "arguments": { + "type": "string" + } + }, + "description": "Database slowlog entry" + }, "ActiveActivePscEndpointUpdateRequest": { "required": [ "endpointId", @@ -13275,20 +13491,20 @@ "properties": { "name": { "type": "string", - "description": "Redis advanced capability name. \nUse GET /database-modules for a list of available capabilities." + "description": "Redis advanced capability name. Use GET /database-modules for a list of available capabilities." }, "parameters": { "type": "object", "additionalProperties": { "type": "object", - "description": "Optional. Redis advanced capability parameters. Use GET /database-modules to view the available capabilities and their parameters.", + "description": "Optional. Redis advanced capability parameters. Use GET /database-modules to get the available capabilities and their parameters.", "example": {} }, - "description": "Optional. Redis advanced capability parameters. Use GET /database-modules to view the available capabilities and their parameters.", + "description": "Optional. Redis advanced capability parameters. Use GET /database-modules to get the available capabilities and their parameters.", "example": {} } }, - "description": "Optional. Redis advanced capabilities (also known as modules) to be provisioned in the database. \nUse GET /database-modules to view a list of available advanced capabilities." + "description": "Optional. Redis advanced capabilities (also known as modules) to be provisioned in the database. Use GET /database-modules to get a list of available advanced capabilities." }, "FixedSubscriptionCreateRequest": { "required": [ @@ -13317,7 +13533,7 @@ }, "paymentMethodId": { "type": "integer", - "description": "Optional. A valid payment method ID for this account. Use GET /payment-methods to view all payment methods for your account. This value is optional if ‘paymentMethod’ is ‘marketplace’, but required for all other account types.", + "description": "Optional. A valid payment method ID for this account. Use GET /payment-methods to get a list of all payment methods for your account. This value is optional if ‘paymentMethod’ is ‘marketplace’, but required for all other account types.", "format": "int32" }, "commandType": { @@ -13335,12 +13551,12 @@ "properties": { "deploymentCIDR": { "type": "string", - "description": "Required for Active-Active subscriptions. Deployment CIDR mask. Must be a valid CIDR format with a range of 256 IP addresses. \nDefault for single-region subscriptions: If using Redis internal cloud account, 192.168.0.0/24", + "description": "Required for Active-Active subscriptions. Deployment CIDR mask. Must be a valid CIDR format with a range of 256 IP addresses. Default for single-region subscriptions: If using Redis internal cloud account, 192.168.0.0/24", "example": "10.0.0.0/24" }, "vpcId": { "type": "string", - "description": "Optional. Enter a VPC identifier that exists in the hosted AWS account. Creates a new VPC if not set. \nVPC Identifier must be in a valid format (for example: 'vpc-0125be68a4625884ad') and must exist within the hosting account.", + "description": "Optional. Enter a VPC identifier that exists in the hosted AWS account. Creates a new VPC if not set. VPC Identifier must be in a valid format (for example: 'vpc-0125be68a4625884ad') and must exist within the hosting account.", "example": "" } }, @@ -13441,7 +13657,7 @@ "minimum": 0.1, "exclusiveMinimum": false, "type": "number", - "description": "Optional. The maximum amount of data in the dataset for this database in GB. You cannot set both datasetSizeInGb and totalMemoryInGb. \nIf ‘replication’ is 'true', the database’s total memory will be twice as large as the datasetSizeInGb.If ‘replication’ is false, the database’s total memory will be the datasetSizeInGb value.", + "description": "Optional. The maximum amount of data in the dataset for this database in GB. You cannot set both datasetSizeInGb and totalMemoryInGb. If ‘replication’ is 'true', the database’s total memory will be twice as large as the datasetSizeInGb.If ‘replication’ is false, the database’s total memory will be the datasetSizeInGb value.", "format": "double", "example": 1 }, @@ -13538,12 +13754,12 @@ "properties": { "name": { "type": "string", - "description": "Required. ACL redis rule name", + "description": "Redis ACL rule name.", "example": "ACL-rule-example" }, "redisRule": { "type": "string", - "description": "Required. ACL redis rule pattern" + "description": "Redis ACL rule pattern. See [ACL syntax](https://redis.io/docs/latest/operate/rc/security/access-control/data-access-control/configure-acls/#define-permissions-with-acl-syntax) to learn how to define rules." }, "commandType": { "type": "string", @@ -13640,7 +13856,7 @@ }, "name": { "type": "string", - "description": "Name of the database. \nDatabase name is limited to 40 characters or less and must include only letters, digits, and hyphens ('-'). It must start with a letter and end with a letter or digit.", + "description": "Name of the database. Database name is limited to 40 characters or less and must include only letters, digits, and hyphens ('-'). It must start with a letter and end with a letter or digit.", "example": "Redis-database-example" }, "protocol": { @@ -13809,7 +14025,7 @@ }, "modules": { "type": "array", - "description": "Optional. Redis advanced capabilities (also known as modules) to be provisioned in the database. Use GET /database-modules to view a list of available advanced capabilities.", + "description": "Optional. Redis advanced capabilities (also known as modules) to be provisioned in the database. Use GET /database-modules to get a list of available advanced capabilities.", "items": { "$ref": "#/components/schemas/DatabaseModuleSpec" } @@ -13872,12 +14088,12 @@ }, "role": { "type": "string", - "description": "Optional. ACL role name", + "description": "Optional. Changes the ACL role assigned to the user. Use GET '/acl/roles' to get a list of database access roles.", "example": "Redis-role-example" }, "password": { "type": "string", - "description": "Optional. ACL User's password.", + "description": "Optional. Changes the user's database password.", "example": "some-random-password" }, "commandType": { @@ -13938,6 +14154,7 @@ "ACTIVE_ACTIVE_SUBSCRIPTION_PREVIEW_REDIS_VERSION_IS_NOT_SUPPORTED", "SUBSCRIPTION_GCP_ALLOW_ONLY_INTERNAL", "CLUSTER_UNDER_MAINTENANCE", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_TYPE_IS_NOT_SUPPORTED", "PLANNED_SUBSCRIPTION_INVALID_PLAN_ID", "PLANNER_TIMEOUT", "PLANNER_FAILURE", @@ -14483,12 +14700,12 @@ "properties": { "name": { "type": "string", - "description": "Required. ACL role name", + "description": "Database access role name.", "example": "ACL-role-example" }, "redisRules": { "type": "array", - "description": "Required. List of ACL redis rules to associated with the requested ACL role", + "description": "A list of Redis ACL rules to assign to this database access role.", "items": { "$ref": "#/components/schemas/AclRoleRedisRuleSpec" } @@ -14665,7 +14882,7 @@ }, "storageType": { "type": "string", - "description": "Required when active is 'true'. Type of storage to host backup files. Can be \"aws-s3\", \"google-blob-storage\", \"azure-blob-storage\", or \"ftp\". \nSee [Set up backup storage locations](https://redis.io/docs/latest/operate/rc/databases/back-up-data/#set-up-backup-storage-locations) to learn how to set up backup storage locations." + "description": "Required when active is 'true'. Type of storage to host backup files. Can be \"aws-s3\", \"google-blob-storage\", \"azure-blob-storage\", or \"ftp\". See [Set up backup storage locations](https://redis.io/docs/latest/operate/rc/databases/back-up-data/#set-up-backup-storage-locations) to learn how to set up backup storage locations." }, "backupStorageType": { "type": "string", @@ -14815,7 +15032,7 @@ }, "paymentMethodId": { "type": "integer", - "description": "Optional. A valid payment method ID for this account. Use GET /payment-methods to view all payment methods for your account. This value is optional if ‘paymentMethod’ is ‘marketplace’, but required for all other account types.", + "description": "Optional. A valid payment method ID for this account. Use GET /payment-methods to get a list of all payment methods for your account. This value is optional if ‘paymentMethod’ is ‘marketplace’, but required for all other account types.", "format": "int32" }, "memoryStorage": { @@ -14827,6 +15044,15 @@ "ram-and-flash" ] }, + "persistentStorageEncryptionType": { + "type": "string", + "description": "Optional. Persistent storage encryption secures data-at-rest for database persistence. You can use 'cloud-provider-managed-key' or 'customer-managed-key'. Default: 'cloud-provider-managed-key'", + "example": "cloud-provider-managed-key", + "enum": [ + "cloud-provider-managed-key", + "customer-managed-key" + ] + }, "cloudProviders": { "type": "array", "description": "Cloud provider, region, and networking details.", @@ -14843,7 +15069,7 @@ }, "redisVersion": { "type": "string", - "description": "Optional. Defines the Redis version of the databases in the subscription. If not set, the Redis version for your databases will be the default version. Use GET /subscriptions/redis-versions to view a list of available Redis versions.", + "description": "Optional. Defines the Redis version of the databases in the subscription. If not set, the Redis version for your databases will be the default version. Use GET /subscriptions/redis-versions to get a list of available Redis versions.", "example": "7.2" }, "commandType": { @@ -14885,27 +15111,27 @@ }, "accessKeyId": { "type": "string", - "description": "Required. Cloud provider access key", + "description": "Cloud provider access key.", "example": "****" }, "accessSecretKey": { "type": "string", - "description": "Required. Cloud provider secret key", + "description": "Cloud provider secret key.", "example": "****" }, "consoleUsername": { "type": "string", - "description": "Required. Cloud provider management console username", + "description": "Cloud provider management console username.", "example": "me@mycompany.com" }, "consolePassword": { "type": "string", - "description": "Required. Cloud provider management console password", + "description": "Cloud provider management console password.", "example": "****" }, "signInLoginUrl": { "type": "string", - "description": "Optional. Cloud provider management console login URL", + "description": "Optional. Cloud provider management console login URL.", "example": "https://.signin.aws.amazon.com/console" }, "commandType": { @@ -15278,7 +15504,7 @@ }, "targetRedisVersion": { "type": "string", - "description": "The target Redis version the database will be upgraded to. Use GET /subscriptions/redis-versions to view a list of available Redis versions.", + "description": "The target Redis version the database will be upgraded to. Use GET /subscriptions/redis-versions to get a list of available Redis versions.", "example": "7.4" }, "commandType": {