diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 7c45943491..5674d4c0b1 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -43,7 +43,7 @@ }, { "name": "Databases - Pro", - "description": "All operations related to Pro databases lifecycle", + "description": "All Pro database operations.", "x-order": "20" }, { @@ -2021,8 +2021,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Get database by id", - "description": "Information on a specific database identified by subscription Id and database Id", + "summary": "Get a single database", + "description": "Gets details and settings of a single database in a Pro subscription.", "operationId": "getSubscriptionDatabaseByID", "parameters": [ { @@ -2039,7 +2039,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "minimum": 0, @@ -2090,7 +2090,7 @@ "Databases - Pro" ], "summary": "Update database", - "description": "Update an existing database", + "description": "Updates an existing database in a Pro subscription.", "operationId": "updateDatabase", "parameters": [ { @@ -2106,7 +2106,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -2189,7 +2189,7 @@ "Databases - Pro" ], "summary": "Delete database", - "description": "Delete a specific database identified by subscription Id and database Id", + "description": "Deletes a database from a Pro subscription.", "operationId": "deleteDatabaseById", "parameters": [ { @@ -2205,7 +2205,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -2263,7 +2263,7 @@ "Databases - Pro" ], "summary": "Get database tags", - "description": "Get database tags for a given resource", + "description": "Gets a list of all database tags.", "operationId": "getTags", "parameters": [ { @@ -2279,7 +2279,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -2328,8 +2328,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Override database tags", - "description": "Override database tags for a given resource", + "summary": "Overwrite database tags", + "description": "Overwrites all tags on the database.", "operationId": "updateTags", "parameters": [ { @@ -2345,7 +2345,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -2410,8 +2410,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Add database tags", - "description": "Add single database tag for a given resource", + "summary": "Add a database tag", + "description": "Adds a single database tag to a database.", "operationId": "createTag", "parameters": [ { @@ -2427,7 +2427,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -2497,8 +2497,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Update database tag by key", - "description": "Update single database tag for a given resource by tag key", + "summary": "Update database tag value", + "description": "Updates the value of the specified database tag.", "operationId": "updateTag", "parameters": [ { @@ -2514,7 +2514,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -2524,7 +2524,7 @@ { "name": "tagKey", "in": "path", - "description": "Tag key", + "description": "Tag Key.", "required": true, "schema": { "type": "string" @@ -2588,8 +2588,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Delete database tag by key", - "description": "Delete database tag for a given resource by tag key", + "summary": "Delete database tag", + "description": "Removes the specified tag from the database.", "operationId": "deleteTag", "parameters": [ { @@ -2605,7 +2605,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -2615,7 +2615,7 @@ { "name": "tagKey", "in": "path", - "description": "Tag key", + "description": "Tag Key.", "required": true, "schema": { "type": "string" @@ -2672,8 +2672,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Update active-active regions", - "description": "Update active-active local database properties", + "summary": "Update Active-Active database", + "description": "(Active-Active databases only) Updates database properties for an Active-Active database.", "operationId": "updateCrdbLocalProperties", "parameters": [ { @@ -2689,7 +2689,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -2776,8 +2776,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Flush database data", - "description": "Flush database data", + "summary": "Flush database", + "description": "Deletes all data from the specified database.", "operationId": "flushCrdb", "parameters": [ { @@ -2793,7 +2793,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -3284,7 +3284,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "minimum": 0, @@ -3351,7 +3351,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -3446,7 +3446,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -3504,7 +3504,7 @@ "Databases - Essentials" ], "summary": "Get database tags", - "description": "Get database tags for a given resource", + "description": "Gets a list of all database tags.", "operationId": "getTags_1", "parameters": [ { @@ -3520,7 +3520,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -3569,8 +3569,8 @@ "tags": [ "Databases - Essentials" ], - "summary": "Override database tags", - "description": "Override database tags for a given resource", + "summary": "Overwrite database tags", + "description": "Overwrites all tags on the database.", "operationId": "updateTags_1", "parameters": [ { @@ -3586,7 +3586,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -3651,8 +3651,8 @@ "tags": [ "Databases - Essentials" ], - "summary": "Add database tags", - "description": "Add single database tag for a given resource", + "summary": "Add a database tag", + "description": "Adds a single database tag to a database.", "operationId": "createTag_1", "parameters": [ { @@ -3668,7 +3668,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -3738,8 +3738,8 @@ "tags": [ "Databases - Essentials" ], - "summary": "Update database tag by key", - "description": "Update single database tag for a given resource by tag key", + "summary": "Update database tag value", + "description": "Updates the value of the specified database tag.", "operationId": "updateTag_1", "parameters": [ { @@ -3755,7 +3755,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -3765,7 +3765,7 @@ { "name": "tagKey", "in": "path", - "description": "Tag key", + "description": "Tag Key.", "required": true, "schema": { "type": "string" @@ -3829,8 +3829,8 @@ "tags": [ "Databases - Essentials" ], - "summary": "Delete database tag by key", - "description": "Delete database tag for a given resource by tag key", + "summary": "Delete database tag", + "description": "Removes the specified tag from the database.", "operationId": "deleteTag_1", "parameters": [ { @@ -3846,7 +3846,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -3856,7 +3856,7 @@ { "name": "tagKey", "in": "path", - "description": "Tag key", + "description": "Tag Key.", "required": true, "schema": { "type": "string" @@ -5940,8 +5940,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Get databases", - "description": "Information on databases belonging to subscription identified by subscription Id", + "summary": "Get all databases in a subscription", + "description": "Gets a list of all databases in the specified Pro subscription.", "operationId": "getSubscriptionDatabases", "parameters": [ { @@ -6019,8 +6019,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Create database", - "description": "Create a new database", + "summary": "Create database in existing subscription", + "description": "Creates a new database in an existing Pro subscription.", "operationId": "createDatabase", "parameters": [ { @@ -6109,13 +6109,163 @@ } } }, + "/subscriptions/{subscriptionId}/databases/{databaseId}/upgrade": { + "get": { + "tags": [ + "Databases - Pro" + ], + "summary": "Database Redis version upgrade status", + "description": "Information on the latest database Redis version upgrade status, identified by subscription Id and database Id", + "operationId": "getDatabaseRedisVersionUpgradeStatus", + "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/BdbVersionUpgradeStatus" + } + } + } + }, + "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 " + } + } + }, + "post": { + "tags": [ + "Databases - Pro" + ], + "summary": "Upgrade database Redis version", + "description": "Upgrade database Redis version", + "operationId": "upgradeDatabaseRedisVersion", + "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" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseUpgradeRedisVersionRequest" + } + } + }, + "required": true + }, + "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/TaskStateUpdate" + } + } + } + }, + "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" + }, + "408": { + "description": "Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period" + }, + "409": { + "description": "Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name)" + }, + "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}/import": { "get": { "tags": [ "Databases - Pro" ], - "summary": "Import database status", - "description": "Information on the latest database import status identified by subscription Id and database Id", + "summary": "Get import status", + "description": "Gets information on the latest import attempt for this database.", "operationId": "getDatabaseImportStatus", "parameters": [ { @@ -6131,7 +6281,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -6180,8 +6330,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Import database", - "description": "Import data from an RDB file or a different Redis database", + "summary": "Import data", + "description": "Imports data from an RDB file or from a different Redis database into this database. \nWARNING: Importing data into a database removes all existing data from the database.", "operationId": "importDatabase", "parameters": [ { @@ -6197,7 +6347,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -6264,8 +6414,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Backup database status", - "description": "Information on the latest database backup status identified by subscription Id and database Id", + "summary": "Get database backup status", + "description": "Gets information on the latest backup attempt for this database.", "operationId": "getDatabaseBackupStatus", "parameters": [ { @@ -6281,7 +6431,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -6339,8 +6489,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Backup database", - "description": "Manually backup a database into the destination defined for it", + "summary": "Back up database", + "description": "Manually back up a database to a backup path. By default, backups will be stored in the 'remoteBackup' location for this database.", "operationId": "backupDatabase", "parameters": [ { @@ -6356,7 +6506,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -6717,7 +6867,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -6783,7 +6933,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -6867,7 +7017,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -6933,7 +7083,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "type": "integer", @@ -8228,8 +8378,8 @@ "tags": [ "Databases - Pro" ], - "summary": "Get database certificate", - "description": "X.509 PEM (base64) encoded certificate for TLS connection to the database", + "summary": "Get database TLS certificate", + "description": "Gets the X.509 PEM (base64) encoded server certificate for TLS connection to the database. Requires 'enableTLS' to be 'true' for the database.", "operationId": "getSubscriptionDatabaseCertificate", "parameters": [ { @@ -8246,7 +8396,7 @@ { "name": "databaseId", "in": "path", - "description": "Database ID", + "description": "Database ID.", "required": true, "schema": { "minimum": 0, @@ -9029,6 +9179,31 @@ }, "description": "User update request" }, + "BdbVersionUpgradeStatus": { + "type": "object", + "properties": { + "databaseId": { + "type": "integer", + "format": "int32" + }, + "targetRedisVersion": { + "type": "string" + }, + "progress": { + "type": "number", + "format": "double" + }, + "upgradeStatus": { + "type": "string", + "enum": [ + "in-progress", + "in-progress-recovery-pending", + "done", + "failed" + ] + } + } + }, "PaymentMethods": { "type": "object", "properties": { @@ -9268,7 +9443,7 @@ }, "value": { "type": "string", - "description": "Required. database tag value" + "description": "Database tag value" }, "commandType": { "type": "string", @@ -9564,6 +9739,11 @@ "resp3" ] }, + "redisVersion": { + "type": "string", + "description": "Optional. If specified, redisVersion defines the Redis database version. If omitted, the Redis version will be set to the default version (available in 'GET /subscriptions/redis-versions')", + "example": "7.2" + }, "shardingType": { "type": "string", "description": "Optional. Database [Hashing policy](https://redis.io/docs/latest/operate/rc/databases/configuration/clustering/#manage-the-hashing-policy).", @@ -9902,19 +10082,19 @@ }, "dryRun": { "type": "boolean", - "description": "Optional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'false'", + "description": "Optional. When 'false': Creates a deployment plan and deploys it, updating any resources required by the plan. When 'true': creates a read-only deployment plan and does not update any resources. Default: 'false'", "example": false }, "name": { "type": "string", - "description": "Optional. Database name", + "description": "Optional. Updated database name.", "example": "Redis-database-example-updated" }, "memoryLimitInGb": { "minimum": 0.1, "exclusiveMinimum": false, "type": "number", - "description": "Deprecated - Optional. Total memory including replication and other overhead", + "description": "Optional. Total memory in GB, including replication and other overhead. You cannot set both datasetSizeInGb and totalMemoryInGb.", "format": "double", "example": 1, "deprecated": true @@ -9923,13 +10103,13 @@ "minimum": 0.1, "exclusiveMinimum": false, "type": "number", - "description": "Optional. The maximum amount of data in the dataset for this specific database is in GB. You can not 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 of the database 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. \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.", "format": "double", "example": 1 }, "respVersion": { "type": "string", - "description": "Optional. RESP version must be compatible with Redis version.", + "description": "Optional. Redis Serialization Protocol version. Must be compatible with Redis version.", "example": "resp3", "enum": [ "resp2", @@ -9941,7 +10121,7 @@ }, "dataPersistence": { "type": "string", - "description": "Optional. Rate of database data persistence (in persistent storage)", + "description": "Optional. Type and rate of data persistence in persistent storage.", "enum": [ "none", "aof-every-1-second", @@ -9953,7 +10133,7 @@ }, "dataEvictionPolicy": { "type": "string", - "description": "Optional. Data items eviction method", + "description": "Optional. Data eviction policy.", "enum": [ "allkeys-lru", "allkeys-lfu", @@ -9967,14 +10147,14 @@ }, "replication": { "type": "boolean", - "description": "Optional. Databases replication" + "description": "Optional. Turns database replication on or off." }, "regexRules": { "type": "array", - "description": "Optional. Shard regex rules. Relevant only for a sharded database", + "description": "Optional. Hashing policy Regex rules. Used only if the hashing policy is 'custom'.", "items": { "type": "string", - "description": "Optional. Shard regex rules. Relevant only for a sharded database" + "description": "Optional. Hashing policy Regex rules. Used only if the hashing policy is 'custom'." } }, "replicaOf": { @@ -9991,60 +10171,60 @@ }, "supportOSSClusterApi": { "type": "boolean", - "description": "Optional. Support Redis open-source (OSS) Cluster API", + "description": "Optional. Support Redis [OSS Cluster API](https://redis.io/docs/latest/operate/rc/databases/configuration/clustering/#oss-cluster-api).", "example": false }, "useExternalEndpointForOSSClusterApi": { "type": "boolean", - "description": "Optional. Should use external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled'. Default: 'false'", + "description": "Optional. If set to 'true', the database will use the external endpoint for OSS Cluster API. This setting blocks the database's private endpoint. Can only be set if 'supportOSSClusterAPI' is 'true'.", "example": false }, "password": { "type": "string", - "description": "Optional. If specified, this password will be used to access the database. Can only be set if Database Protocol is REDIS", + "description": "Optional. Changes the password used to access the database. Can only be set if 'protocol' is 'redis'.", "example": "P@ssw0rd" }, "saslUsername": { "type": "string", - "description": "Optional. If specified, this Memcached (SASL) username will be used to access the database. Can only be set if Database Protocol is Memcached", + "description": "Optional. Changes the Memcached (SASL) username to access the database. Can only be set if 'protocol' is 'memcached'.", "example": "mc-HR7gb" }, "saslPassword": { "type": "string", - "description": "Optional. If specified, this Memcached (SASL) password will be used to access the database. Can only be set if Database Protocol is Memcached", + "description": "Optional. Changes the Memcached (SASL) password to access the database. Can only be set if 'protocol' is 'memcached'.", "example": "7igza2WZ0UPgMyqjsxuIZtla8xBdzkJT" }, "sourceIp": { "type": "array", - "description": "Optional. List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: ['192.168.10.0/32', '192.168.12.0/24'] )", + "description": "Optional. List of source IP addresses or subnet masks to whitelist. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. Example: '['192.168.10.0/32', '192.168.12.0/24']'", "items": { "type": "string", - "description": "Optional. List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: ['192.168.10.0/32', '192.168.12.0/24'] )" + "description": "Optional. List of source IP addresses or subnet masks to whitelist. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. Example: '['192.168.10.0/32', '192.168.12.0/24']'" } }, "clientSslCertificate": { "type": "string", - "description": "Deprecated - Optional. A string containing TLS/SSL certificate (public key) with new line characters replaced by \\n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty string is received, SSL certificate will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'\"", + "description": "Optional. A public key client TLS/SSL certificate with new line characters replaced with '\\n'. If specified, mTLS authentication will be required to authenticate user connections if it is not already required. If set to an empty string, TLS client certificates will be removed and mTLS will not be required. TLS connection may still apply, depending on the value of 'enableTls'.", "deprecated": true }, "clientTlsCertificates": { "type": "array", - "description": "Optional. A list of TLS/SSL certificates (public keys) with new line characters replaced by \\n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty list is received, SSL certificates will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'\"", + "description": "Optional. A list of client TLS/SSL certificates. If specified, mTLS authentication will be required to authenticate user connections. If set to an empty list, TLS client certificates will be removed and mTLS will not be required. TLS connection may still apply, depending on the value of 'enableTls'.", "items": { "$ref": "#/components/schemas/DatabaseCertificateSpec" } }, "enableTls": { "type": "boolean", - "description": "Optional. When 'true', requires TLS authentication for all connections (mTLS with valid clientSslCertificate, regular TLS when the clientSslCertificate is not provided). If enableTls is set to false it will also remove the mTLS requirement (by erasing the content of the clientSslCertificate property). Default: 'false'" + "description": "Optional. When 'true', requires TLS authentication for all connections - mTLS with valid clientTlsCertificates, regular TLS when clientTlsCertificates is not provided. If enableTls is set to 'false' while mTLS is required, it will remove the mTLS requirement and erase previously provided clientTlsCertificates." }, "enableDefaultUser": { "type": "boolean", - "description": "Optional. When 'true', enables connecting to the database with the 'default' user. Default: 'true'. Can only be set if Database Protocol is REDIS" + "description": "Optional. When 'true', allows connecting to the database with the 'default' user. When 'false', only defined access control users can connect to the database. Can only be set if 'protocol' is 'redis'." }, "periodicBackupPath": { "type": "string", - "description": "Deprecated - If specified, automatic backups will be every 24 hours or database will be able to perform immediate backups to this path. If empty string is received, backup path will be removed. Optional.", + "description": "Optional. Changes the backup location path. If specified, the database will back up every 24 hours to this location, and you can manually back up the database to this location at any time. If set to an empty string, the backup path will be removed.", "example": "s3://", "deprecated": true }, @@ -10053,7 +10233,7 @@ }, "alerts": { "type": "array", - "description": "Optional. Redis database alerts", + "description": "Optional. Changes Redis database alert details.", "items": { "$ref": "#/components/schemas/DatabaseAlertSpec" } @@ -10064,7 +10244,7 @@ }, "queryPerformanceFactor": { "type": "string", - "description": "Optional. The query performance factor adds extra compute power specifically for search and query. For databases with search and query, you can increase your search queries per second by the selected factor.", + "description": "Optional. Changes the query performance factor. The query performance factor adds extra compute power specifically for search and query databases. You can increase your queries per second by the selected factor.", "example": "2x" } }, @@ -10075,7 +10255,7 @@ "properties": { "region": { "type": "string", - "description": "Required. Name of the region to update its properties" + "description": "Required. Name of the region to update." }, "remoteBackup": { "$ref": "#/components/schemas/DatabaseBackupConfig" @@ -10085,7 +10265,7 @@ }, "dataPersistence": { "type": "string", - "description": "Optional. Regional instance of an Active-Active database data persistence rate (in persistent storage)", + "description": "Optional. Type and rate of data persistence for this region. If set, 'globalDataPersistence' will not apply to this region.", "enum": [ "none", "aof-every-1-second", @@ -10097,27 +10277,27 @@ }, "password": { "type": "string", - "description": "Optional. If specified, this regional instance of an Active-Active database password will be used to access the database", + "description": "Optional. Changes the password used to access the database in this region. If set, 'globalPassword' will not apply to this region.", "example": "P@ssw0rd" }, "sourceIp": { "type": "array", - "description": "Optional. List of regional instance of an Active-Active database source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: ['192.168.10.0/32', '192.168.12.0/24'] )", + "description": "Optional. List of source IP addresses or subnet masks to whitelist in this region. If set, Redis clients will be able to connect to the database in this region only from within the specified source IP addresses ranges, and 'globalSourceIp' will not apply to this region. Example: ['192.168.10.0/32', '192.168.12.0/24']", "items": { "type": "string", - "description": "Optional. List of regional instance of an Active-Active database source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: ['192.168.10.0/32', '192.168.12.0/24'] )" + "description": "Optional. List of source IP addresses or subnet masks to whitelist in this region. If set, Redis clients will be able to connect to the database in this region only from within the specified source IP addresses ranges, and 'globalSourceIp' will not apply to this region. Example: ['192.168.10.0/32', '192.168.12.0/24']" } }, "alerts": { "type": "array", - "description": "Optional. Redis regional instance of an Active-Active database alerts", + "description": "Optional. Redis database alert settings for this region. If set, 'glboalAlerts' will not apply to this region.", "items": { "$ref": "#/components/schemas/DatabaseAlertSpec" } }, "respVersion": { "type": "string", - "description": "Optional. RESP version must be compatible with Redis version.", + "description": "Optional. Redis Serialization Protocol version for this region. Must be compatible with Redis version.", "example": "resp3", "enum": [ "resp2", @@ -10125,7 +10305,7 @@ ] } }, - "description": "Optional. List or regions to update" + "description": "Optional. A list of regions and local settings to update." }, "PscEndpointCreateRequest": { "required": [ @@ -10699,18 +10879,18 @@ "properties": { "endpoint": { "type": "string", - "description": "Required. A Redis URI (sample format: 'redis://user:password@host:port)'. If the URI provided is Redis Cloud instance, only host and port should be provided (using the format: ['redis://endpoint1:6379', 'redis://endpoint2:6380'] )." + "description": "Required. 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'." }, "encryption": { "type": "boolean", - "description": "Defines if encryption should be used to connect to the sync source. If left null and if the source is a Redis Cloud instance, it will automatically detect if the source uses encryption." + "description": "Defines if encryption should be used to connect to the sync source. If not set the source is a Redis Cloud database, it will automatically detect if the source uses encryption." }, "serverCert": { "type": "string", - "description": "TLS/SSL certificate chain of the sync source. If left null and if the source is a Redis Cloud instance, it will automatically detect the certificate to use." + "description": "TLS/SSL certificate chain of the sync source. If not set and the source is a Redis Cloud database, it will automatically detect the certificate to use." } }, - "description": "Optional. This database will be a replica of the specified Redis databases provided as a list of one or more DatabaseSyncSourceSpec objects." + "description": "Optional. This database will be a replica of the specified Redis databases, provided as a list of objects with endpoint and certificate details." }, "MaintenanceWindow": { "type": "object", @@ -11596,10 +11776,10 @@ "properties": { "publicCertificatePEMString": { "type": "string", - "description": "Required. Public key certificate (PEM format)" + "description": "Client certificate public key in PEM format, with new line characters replaced with '\\n'." } }, - "description": "Optional. A list of TLS/SSL certificates (public keys) with new line characters replaced by \\n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty list is received, SSL certificates will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'\"" + "description": "Optional. A list of client TLS/SSL certificates. If specified, mTLS authentication will be required to authenticate user connections. If set to an empty list, TLS client certificates will be removed and mTLS will not be required. TLS connection may still apply, depending on the value of 'enableTls'." }, "AclRoleUpdateRequest": { "type": "object", @@ -11844,7 +12024,7 @@ "properties": { "publicCertificatePEMString": { "type": "string", - "description": "A list of TLS/SSL certificates (public keys) with new line characters replaced by \\n" + "description": "An X.509 PEM (base64) encoded server certificate with new line characters replaced by '\\n'." } }, "description": "Database certificate" @@ -12644,7 +12824,7 @@ "properties": { "name": { "type": "string", - "description": "Required. Alert name", + "description": "Alert type. Available options depend on Plan type. See [Configure alerts](https://redis.io/docs/latest/operate/rc/databases/monitor-performance/#configure-metric-alerts) for more information.", "example": "dataset-size", "enum": [ "dataset-size", @@ -12659,12 +12839,12 @@ }, "value": { "type": "integer", - "description": "Required. Alert value", + "description": "Value over which an alert will be sent. Default values and range depend on the alert type. See [Configure alerts](https://redis.io/docs/latest/operate/rc/databases/monitor-performance/#configure-metric-alerts) for more information.", "format": "int32", "example": 80 } }, - "description": "Optional. Redis database alerts" + "description": "Optional. Changes Redis database alert details." }, "LocalThroughput": { "type": "object", @@ -12686,7 +12866,7 @@ "example": 1000 } }, - "description": "Local throughput for the regional instance of an Active-Active database" + "description": "Optional. Expected read and write throughput for this region." }, "PscEndpointUpdateRequest": { "required": [ @@ -13016,12 +13196,12 @@ "properties": { "key": { "type": "string", - "description": "Required. Database tag key", + "description": "Database tag key.", "example": "environment" }, "value": { "type": "string", - "description": "Required. Database tag value", + "description": "Database tag value.", "example": "production" }, "commandType": { @@ -13184,7 +13364,7 @@ }, "tags": { "type": "array", - "description": "Required. database tags", + "description": "List of database tags.", "items": { "$ref": "#/components/schemas/tag" } @@ -13240,19 +13420,19 @@ }, "name": { "type": "string", - "description": "Optional. Database name (Database name must be up to 40 characters long, include only letters, digits, or hyphen ('-'), start with a letter, and end with a letter or digit)", + "description": "Optional. Updated database name. 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" }, "dryRun": { "type": "boolean", - "description": "Optional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'false'", + "description": "Optional. When 'false': Creates a deployment plan and deploys it, updating any resources required by the plan. When 'true': creates a read-only deployment plan and does not update any resources. Default: 'false'", "example": false }, "memoryLimitInGb": { "minimum": 0.1, "exclusiveMinimum": false, "type": "number", - "description": "Deprecated - Optional. Total memory including replication and other overhead", + "description": "Optional. Total memory in GB, including replication and other overhead. You cannot set both datasetSizeInGb and totalMemoryInGb.", "format": "double", "example": 1, "deprecated": true @@ -13261,38 +13441,38 @@ "minimum": 0.1, "exclusiveMinimum": false, "type": "number", - "description": "Optional. The maximum amount of data in the dataset for this specific database is in GB. You can not 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 of the database 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. \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.", "format": "double", "example": 1 }, "supportOSSClusterApi": { "type": "boolean", - "description": "Optional. Support Redis open-source (OSS) Cluster API" + "description": "Optional. Support Redis [OSS Cluster API](https://redis.io/docs/latest/operate/rc/databases/configuration/clustering/#oss-cluster-api). Default: 'false'" }, "useExternalEndpointForOSSClusterApi": { "type": "boolean", - "description": "Optional. Should use external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'", + "description": "Optional. If set to 'true', the database will use the external endpoint for OSS Cluster API. This setting blocks the database's private endpoint. Can only be set if 'supportOSSClusterAPI' is 'true'.", "example": false }, "clientSslCertificate": { "type": "string", - "description": "Deprecated - Optional. A string containing TLS/SSL certificate (public key) with new line characters replaced by \\n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty string is received, SSL certificate will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'\"", + "description": "Optional. A public key client TLS/SSL certificate with new line characters replaced with '\\n'. If specified, mTLS authentication will be required to authenticate user connections if it is not already required. If set to an empty string, TLS client certificates will be removed and mTLS will not be required. TLS connection may still apply, depending on the value of 'enableTls'.", "deprecated": true }, "clientTlsCertificates": { "type": "array", - "description": "Optional. A list of TLS/SSL certificates (public keys) with new line characters replaced by \\n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty list is received, SSL certificates will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'\"", + "description": "Optional. A list of client TLS/SSL certificates. If specified, mTLS authentication will be required to authenticate user connections. If set to an empty list, TLS client certificates will be removed and mTLS will not be required. TLS connection may still apply, depending on the value of 'enableTls'.", "items": { "$ref": "#/components/schemas/DatabaseCertificateSpec" } }, "enableTls": { "type": "boolean", - "description": "Optional. When 'true', requires TLS authentication for all connections (mTLS with valid clientSslCertificate, regular TLS when the clientSslCertificate is not provided)" + "description": "Optional. When 'true', requires TLS authentication for all connections - mTLS with valid clientTlsCertificates, regular TLS when clientTlsCertificates is not provided. If enableTls is set to 'false' while mTLS is required, it will remove the mTLS requirement and erase previously provided clientTlsCertificates." }, "globalDataPersistence": { "type": "string", - "description": "Optional. Global rate of database data persistence (in persistent storage) of regions that dont override global settings. Default: 'none'", + "description": "Optional. Type and rate of data persistence in all regions that don't set local 'dataPersistence'.", "enum": [ "none", "aof-every-1-second", @@ -13304,33 +13484,33 @@ }, "globalPassword": { "type": "string", - "description": "Optional. Password to access the database of regions that dont override global settings." + "description": "Optional. Changes the password used to access the database in all regions that don't set a local 'password'." }, "globalSourceIp": { "type": "array", - "description": "Optional. List of source IP addresses or subnet masks of regions that dont override global settings. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: ['192.168.10.0/32', '192.168.12.0/24'] )", + "description": "Optional. List of source IP addresses or subnet masks to whitelist in all regions that don't set local 'sourceIp' settings. If set, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. Example: ['192.168.10.0/32', '192.168.12.0/24']", "items": { "type": "string", - "description": "Optional. List of source IP addresses or subnet masks of regions that dont override global settings. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: ['192.168.10.0/32', '192.168.12.0/24'] )" + "description": "Optional. List of source IP addresses or subnet masks to whitelist in all regions that don't set local 'sourceIp' settings. If set, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. Example: ['192.168.10.0/32', '192.168.12.0/24']" } }, "globalAlerts": { "type": "array", - "description": "Optional. Redis database alerts of regions that don't override global settings", + "description": "Optional. Redis database alert settings in all regions that don't set local 'alerts'.", "items": { "$ref": "#/components/schemas/DatabaseAlertSpec" } }, "regions": { "type": "array", - "description": "Optional. List or regions to update", + "description": "Optional. A list of regions and local settings to update.", "items": { "$ref": "#/components/schemas/LocalRegionProperties" } }, "dataEvictionPolicy": { "type": "string", - "description": "Optional. Data items eviction method.", + "description": "Optional. Data eviction policy.", "enum": [ "allkeys-lru", "allkeys-lfu", @@ -13455,17 +13635,17 @@ }, "dryRun": { "type": "boolean", - "description": "Optional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'true'", + "description": "Optional. When 'false': Creates a deployment plan and deploys it, creating any resources required by the plan. When 'true': creates a read-only deployment plan and does not create any resources. Default: 'false'", "example": false }, "name": { "type": "string", - "description": "Required. 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. \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.", "example": "Redis-database-example" }, "protocol": { "type": "string", - "description": "Optional. Database protocol. Default: 'redis'", + "description": "Optional. Database protocol. Only set to 'memcached' if you have a legacy application. Default: 'redis'", "enum": [ "redis", "memcached" @@ -13473,7 +13653,7 @@ }, "port": { "type": "integer", - "description": "Optional. TCP port on which the database is available (10000-19999). Generated automatically if omitted", + "description": "Optional. TCP port on which the database is available (10000-19999). Generated automatically if not set.", "format": "int32", "example": 10000 }, @@ -13481,7 +13661,7 @@ "minimum": 0.1, "exclusiveMinimum": false, "type": "number", - "description": "Deprecated - Optional. Total memory including replication and other overhead", + "description": "Optional. Total memory in GB, including replication and other overhead. You cannot set both datasetSizeInGb and totalMemoryInGb.", "format": "double", "example": 1, "deprecated": true @@ -13490,13 +13670,18 @@ "minimum": 0.1, "exclusiveMinimum": false, "type": "number", - "description": "Optional. The maximum amount of data in the dataset for this specific database is in GB. You can not 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 of the database 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. \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.", "format": "double", "example": 1 }, + "redisVersion": { + "type": "string", + "description": "Optional. If specified, redisVersion defines the Redis database version. If omitted, the Redis version will be set to the default version (available in 'GET /subscriptions/redis-versions')", + "example": "7.2" + }, "respVersion": { "type": "string", - "description": "Optional. RESP version must be compatible with Redis version.", + "description": "Optional. Redis Serialization Protocol version. Must be compatible with Redis version.", "example": "resp3", "enum": [ "resp2", @@ -13505,17 +13690,17 @@ }, "supportOSSClusterApi": { "type": "boolean", - "description": "Optional. Support Redis open-source (OSS) Cluster API. Default: 'false'", + "description": "Optional. Support [OSS Cluster API](https://redis.io/docs/latest/operate/rc/databases/configuration/clustering/#oss-cluster-api). Default: 'false'. Default: 'false'", "example": false }, "useExternalEndpointForOSSClusterApi": { "type": "boolean", - "description": "Optional. Should use external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled'. Default: 'false'", + "description": "Optional. If set to 'true', the database will use the external endpoint for OSS Cluster API. This setting blocks the database's private endpoint. Can only be set if 'supportOSSClusterAPI' is 'true'. Default: 'false'", "example": false }, "dataPersistence": { "type": "string", - "description": "Optional. Rate of database data persistence (in persistent storage). Default: 'none'", + "description": "Optional. Type and rate of data persistence in persistent storage. Default: 'none'", "enum": [ "none", "aof-every-1-second", @@ -13527,7 +13712,7 @@ }, "dataEvictionPolicy": { "type": "string", - "description": "Optional. Data items eviction method. Default: 'volatile-lru'", + "description": "Optional. Data eviction policy. Default: 'volatile-lru'", "enum": [ "allkeys-lru", "allkeys-lfu", @@ -13541,15 +13726,15 @@ }, "replication": { "type": "boolean", - "description": "Optional. Databases replication. Default: 'true'" + "description": "Optional. Sets database replication. Default: 'true'" }, "replicaOf": { "type": "array", - "description": "Deprecated - Optional. This database will be a replica of the specified Redis databases provided as one or more URI (sample format: 'redis://user:password@host:port)'. If the URI provided is Redis Cloud instance, only host and port should be provided (using the format: ['redis://endpoint1:6379', 'redis://endpoint2:6380']).", + "description": "Optional. This database will be a replica of the specified Redis databases provided as one or more URI(s). Example: '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', 'redis://endpoint2:6380'].", "deprecated": true, "items": { "type": "string", - "description": "Deprecated - Optional. This database will be a replica of the specified Redis databases provided as one or more URI (sample format: 'redis://user:password@host:port)'. If the URI provided is Redis Cloud instance, only host and port should be provided (using the format: ['redis://endpoint1:6379', 'redis://endpoint2:6380'])." + "description": "Optional. This database will be a replica of the specified Redis databases provided as one or more URI(s). Example: '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', 'redis://endpoint2:6380']." } }, "replica": { @@ -13560,19 +13745,19 @@ }, "localThroughputMeasurement": { "type": "array", - "description": "Optional. Throughput measurement for an active-active subscription", + "description": "Optional. Expected throughput per region for an Active-Active database. Default: 1000 read and write ops/sec for each region", "items": { "$ref": "#/components/schemas/LocalThroughput" } }, "averageItemSizeInBytes": { "type": "integer", - "description": "Optional. Relevant only to ram-and-flash subscriptions. Estimated average size (measured in bytes) of the items stored in the database, Default: 1000", + "description": "Optional. Relevant only to ram-and-flash (also known as Auto Tiering) subscriptions. Estimated average size in bytes of the items stored in the database. Default: 1000", "format": "int64" }, "periodicBackupPath": { "type": "string", - "description": "Deprecated - If specified, automatic backups will be every 24 hours or database will be able to perform immediate backups to this path. If empty string is received, backup path will be removed. Optional.", + "description": "Optional. The path to a backup storage location. If specified, the database will back up every 24 hours to this location, and you can manually back up the database to this location at any time.", "example": "s3://", "deprecated": true }, @@ -13581,50 +13766,50 @@ }, "sourceIp": { "type": "array", - "description": "Optional. List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. example value: '['192.168.10.0/32', '192.168.12.0/24']'", + "description": "Optional. List of source IP addresses or subnet masks to whitelist. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. Example: '['192.168.10.0/32', '192.168.12.0/24']'", "items": { "type": "string", - "description": "Optional. List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. example value: '['192.168.10.0/32', '192.168.12.0/24']'" + "description": "Optional. List of source IP addresses or subnet masks to whitelist. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. Example: '['192.168.10.0/32', '192.168.12.0/24']'" } }, "clientSslCertificate": { "type": "string", - "description": "Deprecated - Optional. A string containing TLS/SSL certificate (public key) with new line characters replaced by \\n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty string is received, SSL certificate will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'\"", + "description": "Optional. A public key client TLS/SSL certificate with new line characters replaced with '\\n'. If specified, mTLS authentication will be required to authenticate user connections. Default: 'null'", "deprecated": true }, "clientTlsCertificates": { "type": "array", - "description": "Optional. A list of TLS/SSL certificates (public keys) with new line characters replaced by \\n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty list is received, SSL certificates will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'\"", + "description": "Optional. A list of client TLS/SSL certificates. If specified, mTLS authentication will be required to authenticate user connections.", "items": { "$ref": "#/components/schemas/DatabaseCertificateSpec" } }, "enableTls": { "type": "boolean", - "description": "Optional. When 'true', requires TLS authentication for all connections (mTLS with valid clientSslCertificate, regular TLS when the clientSslCertificate is not provided. Default: 'false'" + "description": "Optional. When 'true', requires TLS authentication for all connections - mTLS with valid clientTlsCertificates, regular TLS when clientTlsCertificates is not provided. Default: 'false'" }, "password": { "type": "string", - "description": "Optional. Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated. Can only be set if Database Protocol is REDIS" + "description": "Optional. Password to access the database. If not set, a random 32-character alphanumeric password will be automatically generated. Can only be set if 'protocol' is 'redis'." }, "saslUsername": { "type": "string", - "description": "Optional. Memcached (SASL) Username to access the database. If omitted, the username will be set to a 'mc-' prefix followed by a random 5 character long alphanumeric. Can only be set if Database Protocol is MEMCACHED" + "description": "Optional. Memcached (SASL) Username to access the database. If not set, the username will be set to a 'mc-' prefix followed by a random 5 character long alphanumeric. Can only be set if 'protocol' is 'memcached'." }, "saslPassword": { "type": "string", - "description": "Optional. Memcached (SASL) Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated. Can only be set if Database Protocol is MEMCACHED" + "description": "Optional. Memcached (SASL) Password to access the database. If not set, a random 32 character long alphanumeric password will be automatically generated. Can only be set if 'protocol' is 'memcached'." }, "alerts": { "type": "array", - "description": "Optional. Redis database alerts", + "description": "Optional. Redis database alert details.", "items": { "$ref": "#/components/schemas/DatabaseAlertSpec" } }, "modules": { "type": "array", - "description": "Optional. Redis modules to be provisioned in the database", + "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.", "items": { "$ref": "#/components/schemas/DatabaseModuleSpec" } @@ -13644,7 +13829,7 @@ }, "queryPerformanceFactor": { "type": "string", - "description": "Optional. The query performance factor adds extra compute power specifically for search and query. For databases with search and query, you can increase your search queries per second by the selected factor.", + "description": "Optional. The query performance factor adds extra compute power specifically for search and query databases. You can increase your queries per second by the selected factor.", "example": "2x" } }, @@ -14330,11 +14515,11 @@ }, "regionName": { "type": "string", - "description": "Optional. Name of cloud provider region where the local database is located. When backing up an active-active database, backup is done separately for each local database at a specified region." + "description": "Required for Active-Active databases. Name of the cloud provider region to back up. When backing up an Active-Active database, you must back up each region separately." }, "adhocBackupPath": { "type": "string", - "description": "Optional. Path for ad-hoc backup.", + "description": "Optional. Manually backs up data to this location, instead of the set 'remoteBackup' location.", "example": "s3://" }, "commandType": { @@ -14408,12 +14593,12 @@ "properties": { "key": { "type": "string", - "description": "Required. Database tag key", + "description": "Database tag key.", "example": "environment" }, "value": { "type": "string", - "description": "Required. Database tag value", + "description": "Database tag value.", "example": "production" }, "subscriptionId": { @@ -14438,11 +14623,11 @@ "properties": { "active": { "type": "boolean", - "description": "Optional, determine whether backup should be active or not. Default: null" + "description": "Optional. Determine if backup should be active. Default: null" }, "interval": { "type": "string", - "description": "Required when active is true, represent the interval between backups, should be in the following format every-x-hours where x is one of (24,12,6,4,2,1). for example: \"every-4-hours\"" + "description": "Required when active is 'true'. Defines the interval between backups. Format: 'every-x-hours', where x is one of 24, 12, 6, 4, 2, or 1. Example: \"every-4-hours\"" }, "backupInterval": { "type": "string", @@ -14458,7 +14643,7 @@ }, "timeUTC": { "type": "string", - "description": "Optional. State the hour which the backup will take place. available only for 12 or 24 hours backup interval. should be specified an hour for example 2 PM as 14:00" + "description": "Optional. Hour when the backup starts. Available only for \"every-12-hours\" and \"every-24-hours\" backup intervals. Specified as an hour in 24-hour UTC time. Example: \"14:00\" is 2 PM UTC." }, "databaseBackupTimeUTC": { "type": "string", @@ -14480,7 +14665,7 @@ }, "storageType": { "type": "string", - "description": "Required when active is true, Type of storage source from which to import the database file (RDB files) or data (Redis connection)" + "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." }, "backupStorageType": { "type": "string", @@ -14496,10 +14681,10 @@ }, "storagePath": { "type": "string", - "description": "Required when active is true, Path for backup" + "description": "Required when active is 'true'. Path to the backup storage location." } }, - "description": "Optional. Database remote backup configuration" + "description": "Optional. Changes Remote backup configuration details." }, "CrdbFlushRequest": { "type": "object", @@ -14780,7 +14965,7 @@ "properties": { "syncSources": { "type": "array", - "description": "Optional. This database will be a replica of the specified Redis databases provided as a list of one or more DatabaseSyncSourceSpec objects.", + "description": "Optional. This database will be a replica of the specified Redis databases, provided as a list of objects with endpoint and certificate details.", "items": { "$ref": "#/components/schemas/DatabaseSyncSourceSpec" } @@ -14810,7 +14995,7 @@ "example": 10000 } }, - "description": "Optional. Throughput measurement method. Default: 25000 ops/sec" + "description": "Optional. Throughput measurement method." }, "FixedDatabase": { "type": "object", @@ -15049,7 +15234,7 @@ }, "sourceType": { "type": "string", - "description": "Required. Type of storage source from which to import the database file (RDB files) or data (Redis connection)", + "description": "Required. Type of storage from which to import the database RDB file or Redis data.", "example": "http", "enum": [ "http", @@ -15062,10 +15247,10 @@ }, "importFromUri": { "type": "array", - "description": "Required. One or more URIs to source data files or Redis databases, as appropriate to specified source type (example: ['http://mydomain.com/redis-backup-file1', 'http://mydomain.com/redis-backup-file2'])", + "description": "Required. One or more paths to source data files or Redis databases, as appropriate to specified source type.", "items": { "type": "string", - "description": "Required. One or more URIs to source data files or Redis databases, as appropriate to specified source type (example: ['http://mydomain.com/redis-backup-file1', 'http://mydomain.com/redis-backup-file2'])" + "description": "Required. One or more paths to source data files or Redis databases, as appropriate to specified source type." } }, "commandType": { @@ -15075,6 +15260,34 @@ }, "description": "Database import request" }, + "DatabaseUpgradeRedisVersionRequest": { + "required": [ + "targetRedisVersion" + ], + "type": "object", + "properties": { + "databaseId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "subscriptionId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "targetRedisVersion": { + "type": "string", + "description": "Required. The target Redis version the database will be upgraded to.", + "example": "7.4" + }, + "commandType": { + "type": "string", + "readOnly": true + } + }, + "description": "Upgrade database Redis version request" + }, "ActiveActiveRegionCreateRequest": { "required": [ "deploymentCIDR"