From 589b1be43af7832f211975ed5ad456738a3f9f50 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Mon, 9 Jun 2025 02:08:07 +0000 Subject: [PATCH 01/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 193 +++++++++++++++++- 1 file changed, 188 insertions(+), 5 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 0943760901..10a3c09569 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -350,7 +350,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionUpdateRequest" + "$ref": "#/components/schemas/BaseSubscriptionUpdateRequest" } } }, @@ -4633,7 +4633,6 @@ "paymentMethod": "credit-card", "paymentMethodId": 12345, "memoryStorage": "ram", - "persistentStorageEncryption": true, "cloudProviders": [ { "provider": "AWS", @@ -8528,6 +8527,18 @@ "summary": "Get available Redis database versions", "description": "Gets a list of all available Redis database versions for Pro subscriptions.", "operationId": "getRedisVersions", + "parameters": [ + { + "name": "subscriptionId", + "in": "query", + "description": "Subscription ID (required for an existing subscription)", + "required": false, + "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" @@ -8931,6 +8942,64 @@ } } }, + "/fixed/redis-versions": { + "get": { + "tags": [ + "Subscriptions - Essentials" + ], + "summary": "Get available Redis database versions for specific Essentials subscription", + "description": "Gets a list of all available Redis database versions for a specific Essentials subscription.", + "operationId": "getRedisVersions_1", + "parameters": [ + { + "name": "subscriptionId", + "in": "query", + "description": "Subscription 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/RedisVersions" + } + } + } + }, + "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": [ @@ -9564,7 +9633,7 @@ "readOnly": true } }, - "description": "Subscription update request" + "description": "Subscription update request message" }, "DatabaseTagUpdateRequest": { "required": [ @@ -10542,6 +10611,29 @@ } ] }, + "BaseSubscriptionUpdateRequest": { + "type": "object", + "properties": { + "subscriptionId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "commandType": { + "type": "string", + "readOnly": true + } + }, + "description": "Subscription update request message", + "oneOf": [ + { + "$ref": "#/components/schemas/SubscriptionUpdateRequest" + }, + { + "$ref": "#/components/schemas/SubscriptionUpdateCMKRequest" + } + ] + }, "Regions": { "type": "object", "properties": { @@ -11239,6 +11331,40 @@ } } }, + "SubscriptionUpdateCMKRequest": { + "required": [ + "customerManagedKeys" + ], + "type": "object", + "properties": { + "subscriptionId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "commandType": { + "type": "string", + "readOnly": true + }, + "deletionGracePeriod": { + "type": "string", + "description": "Optional. The grace period for deleting the subscription. If not set, will default to immediate deletion grace period.", + "example": "alerts-only", + "enum": [ + "alerts-only", + "immediate" + ] + }, + "customerManagedKeys": { + "type": "array", + "description": "The customer managed keys (CMK) to use for this subscription. If is active-active subscription, must set a key for each region.", + "items": { + "$ref": "#/components/schemas/CustomerManagedKey" + } + } + }, + "description": "Subscription update request message" + }, "AccountSubscriptionDatabases": { "type": "object", "properties": { @@ -14154,7 +14280,24 @@ "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", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_IS_NOT_SUPPORTED", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_MISSING_USAGE_PERMISSIONS", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_MISSING_GET_KEY_PERMISSIONS", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_MISSING_GET_IAM_POLICY_PERMISSIONS", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_DISABLED_KEY", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_INVALID_KEY_NAME", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_WRONG_REGION", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_NOT_PENDING", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_INVALID_NUMBER_OF_KEYS", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_REGION_NOT_REQUIRED", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_REGION_REQUIRED", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_MISSING_KEYS", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_INVALID_REGION", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_DUPLICATE_REGIONS", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_INVALID_FORMAT", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_CREATE_FAILED", + "ACTIVE_ACTIVE_CREATE_A_REGION_CUSTOMER_MANAGED_KEY_RESOURCE_NAME_SUBSCRIPTION_IS_NOT_CUSTOMER_MANAGED", + "ACTIVE_ACTIVE_CREATE_A_REGION_CUSTOMER_MANAGED_KEY_RESOURCE_NAME_IS_NOT_SET", "PLANNED_SUBSCRIPTION_INVALID_PLAN_ID", "PLANNER_TIMEOUT", "PLANNER_FAILURE", @@ -14620,7 +14763,10 @@ "DATABASE_REPLICA_OF_INCOMPATIBLE_VERSION", "DATABASE_UPGRADE_FAILED", "DATABASE_INVALID_PLAN_TYPE", - "DATABASE_UPGRADE_IS_NOT_SUPPORTED" + "DATABASE_UPGRADE_IS_NOT_SUPPORTED", + "ACTIVE_ACTIVE_EXTERNAL_ACCOUNTS_NOT_SUPPORTED", + "ACTIVE_ACTIVE_MULTIPLE_CLOUD_ACCOUNTS_NOT_SUPPORTED", + "ACTIVE_ACTIVE_GCP_EXTERNAL_CLOUD_ACCOUNT_NOT_SUPPORTED" ] }, "additionalInfo": { @@ -14903,6 +15049,17 @@ }, "description": "Optional. Changes Remote backup configuration details." }, + "DynamicEndpoints": { + "type": "object", + "properties": { + "public": { + "type": "string" + }, + "private": { + "type": "string" + } + } + }, "CrdbFlushRequest": { "type": "object", "properties": { @@ -15348,6 +15505,9 @@ "privateEndpoint": { "type": "string" }, + "dynamicEndpoints": { + "$ref": "#/components/schemas/DynamicEndpoints" + }, "links": { "type": "array", "items": { @@ -15514,6 +15674,24 @@ }, "description": "Upgrades the specified Pro database to a later Redis version." }, + "CustomerManagedKey": { + "required": [ + "resourceName" + ], + "type": "object", + "properties": { + "resourceName": { + "type": "string", + "description": "Required. Resource name of the customer managed key as defined by the cloud provider.", + "example": "projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME" + }, + "region": { + "type": "string", + "description": "Name of region to for the customer managed key as defined by the cloud provider. Required for active-active subscriptions." + } + }, + "description": "Object representing a customer managed key (CMK), along with the region it is associated to." + }, "ActiveActiveRegionCreateRequest": { "required": [ "deploymentCIDR" @@ -15556,6 +15734,11 @@ "resp3" ] }, + "customerManagedKeyResourceName": { + "type": "string", + "description": "Optional. Resource name of the customer managed key as defined by the cloud provider for customer managed subscriptions.", + "example": "projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME" + }, "commandType": { "type": "string", "readOnly": true From 3760e974724a5f794886bcb93a937b1756426383 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Mon, 16 Jun 2025 02:06:55 +0000 Subject: [PATCH 02/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 194 +++++++++++++++++- 1 file changed, 191 insertions(+), 3 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 10a3c09569..808f18f177 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -41,6 +41,11 @@ "description": "All Pro subscription connectivity operations.", "x-order": "11" }, + { + "name": "Subscriptions - Dedicated", + "description": "All Dedicated subscription operations.", + "x-order": "11" + }, { "name": "Databases - Pro", "description": "All Pro database operations.", @@ -3077,7 +3082,7 @@ ], "summary": "Get a single Essentials subscription", "description": "Gets information on the specified Essentials subscription.", - "operationId": "getSubscriptionById_1", + "operationId": "getSubscriptionById_2", "parameters": [ { "name": "subscriptionId", @@ -6566,6 +6571,71 @@ } } }, + "/subscriptions/dedicated": { + "post": { + "tags": [ + "Subscriptions - Dedicated" + ], + "summary": "Create Dedicated subscription", + "description": "Creates a new Redis Cloud Dedicated subscription.", + "operationId": "createSubscription_1", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionCreateRequest" + } + } + }, + "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" + }, + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaskStateUpdate" + } + } + } + }, + "401": { + "description": "Unauthorized - Authentication failed for requested resource" + }, + "403": { + "description": "Forbidden - Not allowed to create requested resource (primarily due to not active resource)" + }, + "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 the new name" + }, + "422": { + "description": "Unprocessable Entity - The server understands the request, and the syntax of the request is correct, but it was unable to process the contained instructions" + }, + "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/subscriptions": { "get": { "tags": [ @@ -6617,7 +6687,7 @@ ], "summary": "Create Essentials subscription", "description": "Creates a new Essentials subscription.", - "operationId": "createSubscription_1", + "operationId": "createSubscription_2", "requestBody": { "content": { "application/json": { @@ -8577,6 +8647,64 @@ } } }, + "/subscriptions/dedicated/{subscriptionId}": { + "get": { + "tags": [ + "Subscriptions - Dedicated" + ], + "summary": "Get a single dedicated subscription", + "description": "Gets information on the specified dedicated subscription.", + "operationId": "getSubscriptionById_1", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription 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/DedicatedSubscription" + } + } + } + }, + "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 " + } + } + } + }, "/session-logs": { "get": { "tags": [ @@ -10161,6 +10289,11 @@ "description": "(Pay-as-you-go subscriptions only) Optional. Support Redis [OSS Cluster API](https://redis.io/docs/latest/operate/rc/databases/configuration/clustering/#oss-cluster-api). Default: 'false'", "example": true }, + "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 /fixed/redis-versions')", + "example": "7.4" + }, "respVersion": { "type": "string", "description": "Optional. Redis Serialization Protocol version. Must be compatible with Redis version.", @@ -13553,6 +13686,60 @@ }, "description": "Database tag" }, + "DedicatedSubscription": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the subscription", + "format": "int32" + }, + "name": { + "type": "string", + "description": "Name of the subscription" + }, + "paymentMethodId": { + "type": "integer", + "description": "Payment method identifier", + "format": "int32" + }, + "status": { + "type": "string", + "description": "Current status of the subscription" + }, + "memoryStorage": { + "type": "string", + "description": "Memory storage configuration for the subscription", + "enum": [ + "ram", + "ram-and-flash" + ] + }, + "numberOfDatabases": { + "type": "integer", + "description": "Number of databases in the subscription", + "format": "int32" + }, + "paymentMethodType": { + "type": "string", + "description": "Type of payment method used", + "enum": [ + "credit-card", + "marketplace" + ] + }, + "links": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "description": "Redis Dedicated Subscription information" + }, "SubscriptionSpec": { "required": [ "regions" @@ -14433,6 +14620,7 @@ "DATABASE_AVERAGE_ITEM_SIZE_INVALID_VALUE", "DATABASE_REDIS_VERSION_IS_NOT_SUPPORTED", "DATABASE_REDIS_VERSION_IS_NOT_SUPPORTED_FOR_MEMCACHED", + "DATABASE_REDIS_VERSION_IS_REQUIRED", "DATABASE_REDIS_VERSION_INVALID_VALUE", "VPC_PEERING_NOT_ACTIVE", "VPC_PEERING_GENERAL_ERROR", @@ -15234,7 +15422,7 @@ "readOnly": true } }, - "description": "Subscription create request" + "description": "Dedicated Subscription create request" }, "RedisVersions": { "type": "object", From d48a72c3bf39c57678b1231b81c139838c07dd35 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Mon, 30 Jun 2025 02:09:24 +0000 Subject: [PATCH 03/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 82 ++++--------------- 1 file changed, 14 insertions(+), 68 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 808f18f177..149d7d4a8c 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -6571,71 +6571,6 @@ } } }, - "/subscriptions/dedicated": { - "post": { - "tags": [ - "Subscriptions - Dedicated" - ], - "summary": "Create Dedicated subscription", - "description": "Creates a new Redis Cloud Dedicated subscription.", - "operationId": "createSubscription_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionCreateRequest" - } - } - }, - "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" - }, - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaskStateUpdate" - } - } - } - }, - "401": { - "description": "Unauthorized - Authentication failed for requested resource" - }, - "403": { - "description": "Forbidden - Not allowed to create requested resource (primarily due to not active resource)" - }, - "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 the new name" - }, - "422": { - "description": "Unprocessable Entity - The server understands the request, and the syntax of the request is correct, but it was unable to process the contained instructions" - }, - "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/subscriptions": { "get": { "tags": [ @@ -6687,7 +6622,7 @@ ], "summary": "Create Essentials subscription", "description": "Creates a new Essentials subscription.", - "operationId": "createSubscription_2", + "operationId": "createSubscription_1", "requestBody": { "content": { "application/json": { @@ -12391,6 +12326,18 @@ "items": { "type": "string" } + }, + "redisIamRole": { + "type": "string" + }, + "requiredKeyPolicyStatements": { + "type": "object" + }, + "deletionGracePeriodOptions": { + "type": "array", + "items": { + "type": "string" + } } }, "description": "Configuration regarding customer managed persistent storage encryption" @@ -14727,7 +14674,6 @@ "ACTIVE_ACTIVE_CREATE_A_REGION_MUST_BE_DEFINED_ONCE_PER_DATABASE", "ACTIVE_ACTIVE_CREATE_A_REGION_DATABASE_RESP_VERSION_IS_NOT_SUPPORTED", "TOO_MANY_LOCAL_THROUGHPUT_MEASUREMENTS_DEFINED_FOR_SPECIFIED_ACTIVE_ACTIVE_SUBSCRIPTION", - "ACTIVE_ACTIVE_EXTERNAL_CA_NOT_SUPPORTED", "ACTIVE_ACTIVE_RAM_AND_FLASH_MEMORY_STORAGE_NOT_SUPPORTED", "ACTIVE_ACTIVE_DATABASE_MODULE_IS_NOT_SUPPORTED", "ACTIVE_ACTIVE_DATABASE_MODULES_IS_NOT_SUPPORTED", @@ -15422,7 +15368,7 @@ "readOnly": true } }, - "description": "Dedicated Subscription create request" + "description": "Subscription create request" }, "RedisVersions": { "type": "object", From 30d0daa4e687f5f5ff8fb5759d31f9e3f49b6523 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Wed, 2 Jul 2025 02:03:55 +0000 Subject: [PATCH 04/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 119 +----------------- 1 file changed, 1 insertion(+), 118 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 149d7d4a8c..293e3a8cb8 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -41,11 +41,6 @@ "description": "All Pro subscription connectivity operations.", "x-order": "11" }, - { - "name": "Subscriptions - Dedicated", - "description": "All Dedicated subscription operations.", - "x-order": "11" - }, { "name": "Databases - Pro", "description": "All Pro database operations.", @@ -3082,7 +3077,7 @@ ], "summary": "Get a single Essentials subscription", "description": "Gets information on the specified Essentials subscription.", - "operationId": "getSubscriptionById_2", + "operationId": "getSubscriptionById_1", "parameters": [ { "name": "subscriptionId", @@ -8582,64 +8577,6 @@ } } }, - "/subscriptions/dedicated/{subscriptionId}": { - "get": { - "tags": [ - "Subscriptions - Dedicated" - ], - "summary": "Get a single dedicated subscription", - "description": "Gets information on the specified dedicated subscription.", - "operationId": "getSubscriptionById_1", - "parameters": [ - { - "name": "subscriptionId", - "in": "path", - "description": "Subscription 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/DedicatedSubscription" - } - } - } - }, - "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 " - } - } - } - }, "/session-logs": { "get": { "tags": [ @@ -13633,60 +13570,6 @@ }, "description": "Database tag" }, - "DedicatedSubscription": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier for the subscription", - "format": "int32" - }, - "name": { - "type": "string", - "description": "Name of the subscription" - }, - "paymentMethodId": { - "type": "integer", - "description": "Payment method identifier", - "format": "int32" - }, - "status": { - "type": "string", - "description": "Current status of the subscription" - }, - "memoryStorage": { - "type": "string", - "description": "Memory storage configuration for the subscription", - "enum": [ - "ram", - "ram-and-flash" - ] - }, - "numberOfDatabases": { - "type": "integer", - "description": "Number of databases in the subscription", - "format": "int32" - }, - "paymentMethodType": { - "type": "string", - "description": "Type of payment method used", - "enum": [ - "credit-card", - "marketplace" - ] - }, - "links": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - }, - "description": "Redis Dedicated Subscription information" - }, "SubscriptionSpec": { "required": [ "regions" From c1545736048d7c343ad2dd9cf5e018fc85b5808f Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Mon, 14 Jul 2025 02:19:30 +0000 Subject: [PATCH 05/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 528 +++++++++++++++++- 1 file changed, 524 insertions(+), 4 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 293e3a8cb8..0a7fd7dfc2 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -41,6 +41,11 @@ "description": "All Pro subscription connectivity operations.", "x-order": "11" }, + { + "name": "Subscriptions - Dedicated", + "description": "All Dedicated subscription operations.", + "x-order": "11" + }, { "name": "Databases - Pro", "description": "All Pro database operations.", @@ -3077,7 +3082,7 @@ ], "summary": "Get a single Essentials subscription", "description": "Gets information on the specified Essentials subscription.", - "operationId": "getSubscriptionById_1", + "operationId": "getSubscriptionById_2", "parameters": [ { "name": "subscriptionId", @@ -6566,6 +6571,158 @@ } } }, + "/subscriptions/dedicated": { + "get": { + "tags": [ + "Subscriptions - Dedicated" + ], + "summary": "Get Dedicated subscriptions", + "description": "Gets a list of all Dedicated subscriptions in the current account.", + "operationId": "getAllSubscriptions_1", + "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/DedicatedSubscriptions" + } + } + } + }, + "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": [ + "Subscriptions - Dedicated" + ], + "summary": "Create Dedicated subscription", + "description": "Creates a new Redis Cloud Dedicated subscription.", + "operationId": "createSubscription_1", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DedicatedSubscriptionCreateRequest" + }, + "example": { + "name": "My new subscription", + "deploymentType": "single-region", + "replication": true, + "paymentMethod": "credit-card", + "paymentMethodId": 12345, + "cloudProviders": [ + { + "provider": "AWS", + "regions": [ + { + "region": "us-east-1", + "multipleAvailabilityZones": true, + "preferredAvailabilityZones": [ + "use1-az1", + "use1-az2", + "use1-az3" + ], + "networking": { + "deploymentCIDR": "10.0.0.0/24", + "vpcId": "vpc-123456789" + } + } + ], + "instanceTypes": [ + { + "name": "S2", + "quantity": 2 + } + ] + } + ], + "databases": [ + { + "name": "Redis-database-example", + "supportOSSClusterApi": false, + "redisVersion": "8.0", + "port": 1010, + "dataEvictionPolicy": "allkeys-lfu", + "supportSharding": true + } + ] + } + } + }, + "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" + }, + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaskStateUpdate" + } + } + } + }, + "401": { + "description": "Unauthorized - Authentication failed for requested resource" + }, + "403": { + "description": "Forbidden - Not allowed to create requested resource (primarily due to not active resource)" + }, + "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 the new name" + }, + "422": { + "description": "Unprocessable Entity - The server understands the request, and the syntax of the request is correct, but it was unable to process the contained instructions" + }, + "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/subscriptions": { "get": { "tags": [ @@ -6573,7 +6730,7 @@ ], "summary": "Get Essentials subscriptions", "description": "Gets a list of all Essentials subscriptions in the current account.", - "operationId": "getAllSubscriptions_1", + "operationId": "getAllSubscriptions_2", "responses": { "400": { "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" @@ -6617,7 +6774,7 @@ ], "summary": "Create Essentials subscription", "description": "Creates a new Essentials subscription.", - "operationId": "createSubscription_1", + "operationId": "createSubscription_2", "requestBody": { "content": { "application/json": { @@ -8577,6 +8734,64 @@ } } }, + "/subscriptions/dedicated/{subscriptionId}": { + "get": { + "tags": [ + "Subscriptions - Dedicated" + ], + "summary": "Get a single dedicated subscription", + "description": "Gets information on the specified dedicated subscription.", + "operationId": "getSubscriptionById_1", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription 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/DedicatedSubscription" + } + } + } + }, + "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 " + } + } + } + }, "/session-logs": { "get": { "tags": [ @@ -10083,6 +10298,45 @@ ] } }, + "DedicatedSubscriptionSpec": { + "required": [ + "instanceTypes", + "regions" + ], + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "Optional. Cloud provider. Default: 'AWS'", + "example": "AWS", + "enum": [ + "AWS", + "GCP" + ] + }, + "cloudAccountId": { + "type": "integer", + "description": "Optional. Cloud account identifier. Default: Redis internal cloud account (Cloud Account ID = 1). Use GET /cloud-accounts to list all available cloud accounts. Note: A subscription on Google Cloud can be created only with Redis internal cloud account.", + "format": "int32", + "example": 1 + }, + "regions": { + "type": "array", + "description": "The cloud provider region or list of regions (Active-Active only) and networking details.", + "items": { + "$ref": "#/components/schemas/SubscriptionRegionSpec" + } + }, + "instanceTypes": { + "type": "array", + "description": "Instance types and their quantities", + "items": { + "$ref": "#/components/schemas/DedicatedInstanceTypeSpecs" + } + } + }, + "description": "Cloud provider, region, and networking details." + }, "CidrWhiteListUpdateRequest": { "type": "object", "properties": { @@ -11143,6 +11397,65 @@ }, "description": "Optional. This database will be a replica of the specified Redis databases, provided as a list of objects with endpoint and certificate details." }, + "DedicatedSubscriptionCreateRequest": { + "required": [ + "cloudProviders", + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "New subscription name.", + "example": "My new subscription" + }, + "deploymentType": { + "type": "string", + "description": "Optional. When 'single-region' or not set: Creates a single region subscription. When 'active-active': creates an Active-Active (multi-region) subscription.", + "example": "single-region", + "enum": [ + "single-region", + "active-active" + ] + }, + "replication": { + "type": "boolean", + "description": "Optional. Sets database replication. Default: 'true'" + }, + "paymentMethod": { + "type": "string", + "description": "Optional. The payment method for the subscription. If set to ‘credit-card’, ‘paymentMethodId’ must be defined. Default: 'credit-card'", + "enum": [ + "credit-card", + "marketplace" + ] + }, + "paymentMethodId": { + "type": "integer", + "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" + }, + "cloudProviders": { + "type": "array", + "description": "Cloud provider, region, and networking details.", + "items": { + "$ref": "#/components/schemas/DedicatedSubscriptionSpec" + } + }, + "databases": { + "type": "array", + "description": "One or more database specification(s) to create in this subscription.", + "items": { + "$ref": "#/components/schemas/DedicatedSubscriptionDatabaseSpec" + } + }, + "commandType": { + "type": "string", + "readOnly": true + } + }, + "description": "Dedicated Subscription create request" + }, "MaintenanceWindow": { "type": "object", "properties": { @@ -11316,6 +11629,31 @@ }, "description": "Essentials subscription update request" }, + "DedicatedSubscriptions": { + "type": "object", + "properties": { + "accountId": { + "type": "integer", + "format": "int32" + }, + "subscriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DedicatedSubscription" + } + }, + "links": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "description": "RedisLabs list of dedicated subscriptions in current account" + }, "SearchScalingFactorsData": { "type": "object", "properties": { @@ -13570,6 +13908,129 @@ }, "description": "Database tag" }, + "DedicatedInstanceTypeSpecs": { + "required": [ + "name", + "quantity" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Instance type name" + }, + "quantity": { + "type": "integer", + "description": "Instance type quantity", + "format": "int32" + } + }, + "description": "Instance types and their quantities" + }, + "DedicatedSubscription": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the subscription", + "format": "int32" + }, + "name": { + "type": "string", + "description": "Name of the subscription" + }, + "paymentMethodId": { + "type": "integer", + "description": "Payment method identifier", + "format": "int32" + }, + "status": { + "type": "string", + "description": "Current status of the subscription" + }, + "memoryStorage": { + "type": "string", + "description": "Memory storage configuration for the subscription", + "enum": [ + "ram", + "ram-and-flash" + ] + }, + "numberOfDatabases": { + "type": "integer", + "description": "Number of databases in the subscription", + "format": "int32" + }, + "paymentMethodType": { + "type": "string", + "description": "Type of payment method used", + "enum": [ + "credit-card", + "marketplace" + ] + }, + "links": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "totalSizeInGb": { + "type": "number", + "format": "float" + } + }, + "description": "Redis Dedicated Subscription information", + "example": { + "id": 1207, + "name": "my dedicated subscription", + "paymentMethodId": 1234, + "status": "active", + "memoryStorage": "ram", + "storageEncryption": true, + "numberOfDatabases": 1, + "paymentMethodType": "credit-card", + "deploymentType": "single-region", + "instanceTypes": [ + { + "name": "S1", + "quantity": 2 + } + ], + "cloudDetails": [ + { + "provider": "AWS", + "regions": [ + { + "region": "us-east-1", + "networking": [ + { + "deploymentCIDR": "192.168.0.0/24" + } + ], + "preferredAvailabilityZones": [ + "use1-az1", + "use1-az2", + "use1-az3" + ] + } + ], + "links": [] + } + ], + "subscriptionPricing": [], + "links": [ + { + "type": "GET", + "href": "http://localhost:8081/v1/subscriptions/dedicated/1207", + "rel": "self" + } + ] + } + }, "SubscriptionSpec": { "required": [ "regions" @@ -13954,6 +14415,55 @@ }, "description": "The cloud provider region or list of regions (Active-Active only) and networking details." }, + "DedicatedSubscriptionDatabaseSpec": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "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" + }, + "supportOSSClusterApi": { + "type": "boolean", + "description": "Optional. Support Redis [OSS Cluster API](https://redis.io/docs/latest/operate/rc/databases/configuration/clustering/#oss-cluster-api). Default: 'false'", + "example": false + }, + "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" + }, + "port": { + "type": "integer", + "description": "Optional. TCP port on which the database is available (10000-19999). Generated automatically if not set.", + "format": "int32", + "example": 10000 + }, + "dataEvictionPolicy": { + "type": "string", + "description": "Optional. Data eviction policy. Default: 'volatile-lru'", + "enum": [ + "allkeys-lru", + "allkeys-lfu", + "allkeys-random", + "volatile-lru", + "volatile-lfu", + "volatile-random", + "volatile-ttl", + "noeviction" + ] + }, + "supportSharding": { + "type": "boolean", + "description": "Optional. Support sharding. Default: 'false'", + "example": false + } + }, + "description": "One or more database specification(s) to create in this subscription." + }, "VpcPeeringCreateGcpRequest": { "required": [ "vpcNetworkName", @@ -14297,6 +14807,7 @@ "ACTIVE_ACTIVE_SUBSCRIPTION_PREVIEW_REDIS_VERSION_IS_NOT_SUPPORTED", "SUBSCRIPTION_GCP_ALLOW_ONLY_INTERNAL", "CLUSTER_UNDER_MAINTENANCE", + "ACTIVE_ACTIVE_SUBSCRIPTION_IS_NOT_SUPPORTED", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_IS_NOT_SUPPORTED", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_MISSING_USAGE_PERMISSIONS", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_MISSING_GET_KEY_PERMISSIONS", @@ -14610,6 +15121,7 @@ "UPDATING_A_SINGLE_REGION_VPC_PEERING_IS_NOT_ALLOWED_WITH_ACTIVE_ACTIVE_SUBSCRIPTION", "DELETING_SINGLE_REGION_VPC_PEERING_IS_NOT_ALLOWED_WITH_ACTIVE_ACTIVE_SUBSCRIPTION", "GETTING_SINGLE_REGION_VPC_PEERINGS_IS_NOT_ALLOWED_WITH_ACTIVE_ACTIVE_SUBSCRIPTION", + "ACTIVE_ACTIVE_DATABASE_LIMIT_EXCEEDED", "FIXED_DATABASE_NAME_IS_MISSING", "CREATING_FIXED_DATABASE_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION", "UPDATING_FIXED_DATABASE_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION", @@ -14783,7 +15295,10 @@ "DATABASE_UPGRADE_IS_NOT_SUPPORTED", "ACTIVE_ACTIVE_EXTERNAL_ACCOUNTS_NOT_SUPPORTED", "ACTIVE_ACTIVE_MULTIPLE_CLOUD_ACCOUNTS_NOT_SUPPORTED", - "ACTIVE_ACTIVE_GCP_EXTERNAL_CLOUD_ACCOUNT_NOT_SUPPORTED" + "ACTIVE_ACTIVE_GCP_EXTERNAL_CLOUD_ACCOUNT_NOT_SUPPORTED", + "DEDICATED_SUBSCRIPTION_PREFERRED_AZ_INVALID_VALUE", + "DEDICATED_SUBSCRIPTION_INVALID_INSTANCE_NAME", + "DEDICATED_SUBSCRIPTION_INVALID_REPLICATION" ] }, "additionalInfo": { @@ -15724,6 +16239,11 @@ "type": "string", "description": "Name of region to add as defined by the cloud provider." }, + "vpcId": { + "type": "string", + "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 and must exist within the hosting account.", + "example": "vpc-0125be68a4625884ad" + }, "deploymentCIDR": { "type": "string", "description": "Deployment CIDR mask. Must be a valid CIDR format with a range of 256 IP addresses.", From 69bbaf255fbea5b6e72d13324166a47d5df9f0d8 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Wed, 16 Jul 2025 02:09:58 +0000 Subject: [PATCH 06/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 516 +----------------- 1 file changed, 3 insertions(+), 513 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 0a7fd7dfc2..1096fa896f 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -41,11 +41,6 @@ "description": "All Pro subscription connectivity operations.", "x-order": "11" }, - { - "name": "Subscriptions - Dedicated", - "description": "All Dedicated subscription operations.", - "x-order": "11" - }, { "name": "Databases - Pro", "description": "All Pro database operations.", @@ -3082,7 +3077,7 @@ ], "summary": "Get a single Essentials subscription", "description": "Gets information on the specified Essentials subscription.", - "operationId": "getSubscriptionById_2", + "operationId": "getSubscriptionById_1", "parameters": [ { "name": "subscriptionId", @@ -6571,158 +6566,6 @@ } } }, - "/subscriptions/dedicated": { - "get": { - "tags": [ - "Subscriptions - Dedicated" - ], - "summary": "Get Dedicated subscriptions", - "description": "Gets a list of all Dedicated subscriptions in the current account.", - "operationId": "getAllSubscriptions_1", - "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/DedicatedSubscriptions" - } - } - } - }, - "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": [ - "Subscriptions - Dedicated" - ], - "summary": "Create Dedicated subscription", - "description": "Creates a new Redis Cloud Dedicated subscription.", - "operationId": "createSubscription_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DedicatedSubscriptionCreateRequest" - }, - "example": { - "name": "My new subscription", - "deploymentType": "single-region", - "replication": true, - "paymentMethod": "credit-card", - "paymentMethodId": 12345, - "cloudProviders": [ - { - "provider": "AWS", - "regions": [ - { - "region": "us-east-1", - "multipleAvailabilityZones": true, - "preferredAvailabilityZones": [ - "use1-az1", - "use1-az2", - "use1-az3" - ], - "networking": { - "deploymentCIDR": "10.0.0.0/24", - "vpcId": "vpc-123456789" - } - } - ], - "instanceTypes": [ - { - "name": "S2", - "quantity": 2 - } - ] - } - ], - "databases": [ - { - "name": "Redis-database-example", - "supportOSSClusterApi": false, - "redisVersion": "8.0", - "port": 1010, - "dataEvictionPolicy": "allkeys-lfu", - "supportSharding": true - } - ] - } - } - }, - "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" - }, - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaskStateUpdate" - } - } - } - }, - "401": { - "description": "Unauthorized - Authentication failed for requested resource" - }, - "403": { - "description": "Forbidden - Not allowed to create requested resource (primarily due to not active resource)" - }, - "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 the new name" - }, - "422": { - "description": "Unprocessable Entity - The server understands the request, and the syntax of the request is correct, but it was unable to process the contained instructions" - }, - "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/subscriptions": { "get": { "tags": [ @@ -6730,7 +6573,7 @@ ], "summary": "Get Essentials subscriptions", "description": "Gets a list of all Essentials subscriptions in the current account.", - "operationId": "getAllSubscriptions_2", + "operationId": "getAllSubscriptions_1", "responses": { "400": { "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" @@ -6774,7 +6617,7 @@ ], "summary": "Create Essentials subscription", "description": "Creates a new Essentials subscription.", - "operationId": "createSubscription_2", + "operationId": "createSubscription_1", "requestBody": { "content": { "application/json": { @@ -8734,64 +8577,6 @@ } } }, - "/subscriptions/dedicated/{subscriptionId}": { - "get": { - "tags": [ - "Subscriptions - Dedicated" - ], - "summary": "Get a single dedicated subscription", - "description": "Gets information on the specified dedicated subscription.", - "operationId": "getSubscriptionById_1", - "parameters": [ - { - "name": "subscriptionId", - "in": "path", - "description": "Subscription 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/DedicatedSubscription" - } - } - } - }, - "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 " - } - } - } - }, "/session-logs": { "get": { "tags": [ @@ -10298,45 +10083,6 @@ ] } }, - "DedicatedSubscriptionSpec": { - "required": [ - "instanceTypes", - "regions" - ], - "type": "object", - "properties": { - "provider": { - "type": "string", - "description": "Optional. Cloud provider. Default: 'AWS'", - "example": "AWS", - "enum": [ - "AWS", - "GCP" - ] - }, - "cloudAccountId": { - "type": "integer", - "description": "Optional. Cloud account identifier. Default: Redis internal cloud account (Cloud Account ID = 1). Use GET /cloud-accounts to list all available cloud accounts. Note: A subscription on Google Cloud can be created only with Redis internal cloud account.", - "format": "int32", - "example": 1 - }, - "regions": { - "type": "array", - "description": "The cloud provider region or list of regions (Active-Active only) and networking details.", - "items": { - "$ref": "#/components/schemas/SubscriptionRegionSpec" - } - }, - "instanceTypes": { - "type": "array", - "description": "Instance types and their quantities", - "items": { - "$ref": "#/components/schemas/DedicatedInstanceTypeSpecs" - } - } - }, - "description": "Cloud provider, region, and networking details." - }, "CidrWhiteListUpdateRequest": { "type": "object", "properties": { @@ -11397,65 +11143,6 @@ }, "description": "Optional. This database will be a replica of the specified Redis databases, provided as a list of objects with endpoint and certificate details." }, - "DedicatedSubscriptionCreateRequest": { - "required": [ - "cloudProviders", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "New subscription name.", - "example": "My new subscription" - }, - "deploymentType": { - "type": "string", - "description": "Optional. When 'single-region' or not set: Creates a single region subscription. When 'active-active': creates an Active-Active (multi-region) subscription.", - "example": "single-region", - "enum": [ - "single-region", - "active-active" - ] - }, - "replication": { - "type": "boolean", - "description": "Optional. Sets database replication. Default: 'true'" - }, - "paymentMethod": { - "type": "string", - "description": "Optional. The payment method for the subscription. If set to ‘credit-card’, ‘paymentMethodId’ must be defined. Default: 'credit-card'", - "enum": [ - "credit-card", - "marketplace" - ] - }, - "paymentMethodId": { - "type": "integer", - "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" - }, - "cloudProviders": { - "type": "array", - "description": "Cloud provider, region, and networking details.", - "items": { - "$ref": "#/components/schemas/DedicatedSubscriptionSpec" - } - }, - "databases": { - "type": "array", - "description": "One or more database specification(s) to create in this subscription.", - "items": { - "$ref": "#/components/schemas/DedicatedSubscriptionDatabaseSpec" - } - }, - "commandType": { - "type": "string", - "readOnly": true - } - }, - "description": "Dedicated Subscription create request" - }, "MaintenanceWindow": { "type": "object", "properties": { @@ -11629,31 +11316,6 @@ }, "description": "Essentials subscription update request" }, - "DedicatedSubscriptions": { - "type": "object", - "properties": { - "accountId": { - "type": "integer", - "format": "int32" - }, - "subscriptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DedicatedSubscription" - } - }, - "links": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - }, - "description": "RedisLabs list of dedicated subscriptions in current account" - }, "SearchScalingFactorsData": { "type": "object", "properties": { @@ -13908,129 +13570,6 @@ }, "description": "Database tag" }, - "DedicatedInstanceTypeSpecs": { - "required": [ - "name", - "quantity" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Instance type name" - }, - "quantity": { - "type": "integer", - "description": "Instance type quantity", - "format": "int32" - } - }, - "description": "Instance types and their quantities" - }, - "DedicatedSubscription": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier for the subscription", - "format": "int32" - }, - "name": { - "type": "string", - "description": "Name of the subscription" - }, - "paymentMethodId": { - "type": "integer", - "description": "Payment method identifier", - "format": "int32" - }, - "status": { - "type": "string", - "description": "Current status of the subscription" - }, - "memoryStorage": { - "type": "string", - "description": "Memory storage configuration for the subscription", - "enum": [ - "ram", - "ram-and-flash" - ] - }, - "numberOfDatabases": { - "type": "integer", - "description": "Number of databases in the subscription", - "format": "int32" - }, - "paymentMethodType": { - "type": "string", - "description": "Type of payment method used", - "enum": [ - "credit-card", - "marketplace" - ] - }, - "links": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - }, - "totalSizeInGb": { - "type": "number", - "format": "float" - } - }, - "description": "Redis Dedicated Subscription information", - "example": { - "id": 1207, - "name": "my dedicated subscription", - "paymentMethodId": 1234, - "status": "active", - "memoryStorage": "ram", - "storageEncryption": true, - "numberOfDatabases": 1, - "paymentMethodType": "credit-card", - "deploymentType": "single-region", - "instanceTypes": [ - { - "name": "S1", - "quantity": 2 - } - ], - "cloudDetails": [ - { - "provider": "AWS", - "regions": [ - { - "region": "us-east-1", - "networking": [ - { - "deploymentCIDR": "192.168.0.0/24" - } - ], - "preferredAvailabilityZones": [ - "use1-az1", - "use1-az2", - "use1-az3" - ] - } - ], - "links": [] - } - ], - "subscriptionPricing": [], - "links": [ - { - "type": "GET", - "href": "http://localhost:8081/v1/subscriptions/dedicated/1207", - "rel": "self" - } - ] - } - }, "SubscriptionSpec": { "required": [ "regions" @@ -14415,55 +13954,6 @@ }, "description": "The cloud provider region or list of regions (Active-Active only) and networking details." }, - "DedicatedSubscriptionDatabaseSpec": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "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" - }, - "supportOSSClusterApi": { - "type": "boolean", - "description": "Optional. Support Redis [OSS Cluster API](https://redis.io/docs/latest/operate/rc/databases/configuration/clustering/#oss-cluster-api). Default: 'false'", - "example": false - }, - "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" - }, - "port": { - "type": "integer", - "description": "Optional. TCP port on which the database is available (10000-19999). Generated automatically if not set.", - "format": "int32", - "example": 10000 - }, - "dataEvictionPolicy": { - "type": "string", - "description": "Optional. Data eviction policy. Default: 'volatile-lru'", - "enum": [ - "allkeys-lru", - "allkeys-lfu", - "allkeys-random", - "volatile-lru", - "volatile-lfu", - "volatile-random", - "volatile-ttl", - "noeviction" - ] - }, - "supportSharding": { - "type": "boolean", - "description": "Optional. Support sharding. Default: 'false'", - "example": false - } - }, - "description": "One or more database specification(s) to create in this subscription." - }, "VpcPeeringCreateGcpRequest": { "required": [ "vpcNetworkName", From 4e0b985625692afb0a0b0223be36960ec01eaa46 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Mon, 11 Aug 2025 02:20:52 +0000 Subject: [PATCH 07/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 793 +++++++++--------- 1 file changed, 401 insertions(+), 392 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 1096fa896f..2308c94c30 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -99,12 +99,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -165,12 +165,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -227,12 +227,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -291,12 +291,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -357,12 +357,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -419,12 +419,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -503,12 +503,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -575,12 +575,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -650,12 +650,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -724,12 +724,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -798,12 +798,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -893,12 +893,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -976,12 +976,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -1062,12 +1062,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -1147,12 +1147,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -1251,12 +1251,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -1343,12 +1343,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -1433,12 +1433,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -1505,12 +1505,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -1599,12 +1599,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -1681,12 +1681,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -1771,12 +1771,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -1843,12 +1843,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -1907,12 +1907,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -1973,12 +1973,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -2049,12 +2049,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -2142,12 +2142,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -2214,12 +2214,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -2288,12 +2288,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -2364,12 +2364,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -2446,12 +2446,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -2542,12 +2542,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -2624,12 +2624,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -2728,12 +2728,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -2812,12 +2812,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -2876,12 +2876,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -2942,12 +2942,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -3027,12 +3027,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -3091,12 +3091,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -3156,12 +3156,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -3218,12 +3218,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -3294,12 +3294,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -3383,13 +3383,13 @@ "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": { + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, + "200": { "description": "OK", "content": { "application/json": { @@ -3455,12 +3455,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -3529,12 +3529,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -3605,12 +3605,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -3687,12 +3687,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -3783,12 +3783,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -3865,12 +3865,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -3930,12 +3930,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -3997,12 +3997,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -4060,12 +4060,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -4125,12 +4125,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -4191,12 +4191,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -4253,12 +4253,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -4327,12 +4327,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -4389,12 +4389,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -4463,12 +4463,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -4525,12 +4525,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -4577,12 +4577,12 @@ "description": "Gets a list of all Pro subscriptions in the current account.", "operationId": "getAllSubscriptions", "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -4673,12 +4673,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -4740,12 +4740,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -4806,12 +4806,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -4878,12 +4878,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -4952,12 +4952,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -5018,12 +5018,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -5093,12 +5093,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -5177,12 +5177,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -5263,12 +5263,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -5330,12 +5330,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -5406,12 +5406,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -5473,12 +5473,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -5529,12 +5529,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -5594,12 +5594,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -5668,12 +5668,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -5744,12 +5744,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -5811,12 +5811,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -5888,12 +5888,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -5978,12 +5978,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -6062,12 +6062,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -6139,12 +6139,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -6215,12 +6215,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -6289,12 +6289,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -6365,12 +6365,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -6448,12 +6448,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -6523,12 +6523,12 @@ } }, "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -6575,12 +6575,12 @@ "description": "Gets a list of all Essentials subscriptions in the current account.", "operationId": "getAllSubscriptions_1", "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -6629,12 +6629,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -6719,12 +6719,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -6798,12 +6798,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -6875,12 +6875,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -6951,12 +6951,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7025,12 +7025,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7100,12 +7100,12 @@ } }, "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7152,12 +7152,12 @@ "description": "Gets a list of all configured cloud accounts.", "operationId": "getCloudAccounts", "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7206,12 +7206,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -7261,12 +7261,12 @@ "description": "Gets a list of all access control users for this account.", "operationId": "getAllUsers_1", "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7315,12 +7315,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -7370,12 +7370,12 @@ "description": "Gets a list of all database access roles for this account.", "operationId": "getRoles", "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7424,12 +7424,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -7479,12 +7479,12 @@ "description": "Gets a list of all Redis ACL rules for this account.", "operationId": "getAllRedisRules", "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7533,12 +7533,12 @@ "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -7588,12 +7588,12 @@ "description": "Gets a list of all account users.", "operationId": "getAllUsers", "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7634,12 +7634,12 @@ "description": "Gets a list of all currently running tasks for this account.", "operationId": "getAllTasks", "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7691,12 +7691,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7749,12 +7749,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7807,12 +7807,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7876,12 +7876,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -7945,12 +7945,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -8033,12 +8033,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -8121,12 +8121,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -8199,12 +8199,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -8277,12 +8277,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "202": { "description": "Accepted", "content": { @@ -8335,12 +8335,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -8412,12 +8412,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -8482,12 +8482,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -8540,12 +8540,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -8612,12 +8612,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -8673,12 +8673,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -8719,12 +8719,12 @@ "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": { - "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -8765,12 +8765,12 @@ "description": "Gets a list of all payment methods for this account.", "operationId": "getAccountPaymentMethods", "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -8837,12 +8837,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -8905,12 +8905,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -8963,12 +8963,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -9034,12 +9034,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -9092,12 +9092,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -9150,12 +9150,12 @@ } ], "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -9196,12 +9196,12 @@ "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": { - "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -9242,12 +9242,12 @@ "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": { - "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -9288,12 +9288,12 @@ "description": "Gets information on this account.", "operationId": "getCurrentAccount", "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" }, + "400": { + "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" + }, "200": { "description": "OK", "content": { @@ -11357,7 +11357,14 @@ "example": "alerts-only", "enum": [ "alerts-only", - "immediate" + "immediate", + "15-minutes", + "30-minutes", + "1-hour", + "4-hours", + "8-hours", + "12-hours", + "24-hours" ] }, "customerManagedKeys": { @@ -14612,6 +14619,7 @@ "DELETING_SINGLE_REGION_VPC_PEERING_IS_NOT_ALLOWED_WITH_ACTIVE_ACTIVE_SUBSCRIPTION", "GETTING_SINGLE_REGION_VPC_PEERINGS_IS_NOT_ALLOWED_WITH_ACTIVE_ACTIVE_SUBSCRIPTION", "ACTIVE_ACTIVE_DATABASE_LIMIT_EXCEEDED", + "ACTIVE_ACTIVE_REGION_LIMIT_REACHED", "FIXED_DATABASE_NAME_IS_MISSING", "CREATING_FIXED_DATABASE_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION", "UPDATING_FIXED_DATABASE_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION", @@ -14762,6 +14770,7 @@ "DATABASE_NAME_CHANGE_NOT_SUPPORTED", "DATABASE_INVALID_LOCATION_BACKUP", "DATABASE_GENERAL_ERROR_BACKUP", + "CLUSTER_COMMUNICATION_ERROR", "MAINTENANCE_WINDOW_INVALID_MAINTENANCE_WINDOW_SPEC_PROVIDED", "MAINTENANCE_WINDOW_INVALID_MAINTENANCE_WINDOW_MODE_PROVIDED", "MAINTENANCE_WINDOW_MANUAL_MODE_WITH_NO_MAINTENANCE_WINDOWS", From c76caf06e063b70ee83b0aadc1d54e9b05886056 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 02:01:27 +0000 Subject: [PATCH 08/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 33 +++++++++++++++---- 1 file changed, 27 insertions(+), 6 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 2308c94c30..a64a2ce2e1 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -13694,20 +13694,32 @@ "description": "Essentials subscription create request" }, "SubscriptionRegionNetworkingSpec": { - "required": [ - "deploymentCIDR" - ], "type": "object", "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. Default for single-region subscriptions: If using Redis internal cloud account, 192.168.0.0/24", + "description": "Optional. 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. VPC Identifier must be in a valid format (for example: 'vpc-0125be68a4625884ad') and must exist within the hosting account.", "example": "" + }, + "subnetIds": { + "type": "array", + "description": "Optional. Enter a list of subnets identifiers that exists in the hosted AWS account. Subnet Identifier must exist within the hosting account.", + "example": "", + "items": { + "type": "string", + "description": "Optional. Enter a list of subnets identifiers that exists in the hosted AWS account. Subnet Identifier must exist within the hosting account.", + "example": "" + } + }, + "securityGroupId": { + "type": "string", + "description": "Optional. Enter a security group identifier that exists in the hosted AWS account. Security group Identifier must be in a valid format (for example: 'sg-0125be68a4625884ad') and must exist within the hosting account.", + "example": "" } }, "description": "Optional. Cloud networking details, per region. Required if creating an Active-Active subscription." @@ -14290,6 +14302,12 @@ "SUBSCRIPTION_NETWORKING_MISSING", "SUBSCRIPTION_NETWORKING_CIDR_MISSING", "SUBSCRIPTION_INVALID_CIDR", + "SUBSCRIPTION_NETWORKING_SECURITY_GROUP_MISSING", + "SUBSCRIPTION_NETWORKING_SUBNET_IDS_MISSING", + "SUBSCRIPTION_NETWORKING_VPC_ID_MISSING", + "SUBSCRIPTION_NETWORKING_CIDR_IS_NOT_SUPPORTED", + "SUBSCRIPTION_NETWORKING_VPC_WITH_SUBNETS_AND_SECURITY_GROUP_IS_NOT_SUPPORTED", + "SUBSCRIPTION_INVALID_NUMBER_OF_SUBNET_IDS", "SUBSCRIPTION_PI_NOT_FOUND", "SUBSCRIPTION_INVALID_REGION_NAME", "SUBSCRIPTION_INVALID_REGION_ID", @@ -14663,6 +14681,8 @@ "FIXED_DATABASE_NUMBER_OF_SHARDS_SUPPORTED_ONLY_FOR_PAY_AS_YOU_GO", "FIXED_DATABASE_NUMBER_OF_SHARDS_NOT_A_MULTIPLE_OF_CURRENT_VALUE", "VPC_ID_NOT_ALLOWED_WITH_INTERNAL_CLOUD_ACCOUNT", + "SUBNET_ID_NOT_ALLOWED_WITH_INTERNAL_CLOUD_ACCOUNT", + "SECURITY_GROUP_ID_NOT_ALLOWED_WITH_INTERNAL_CLOUD_ACCOUNT", "CLIENT_SSL_CERTIFICATE_IS_NOT_ALLOWED_WITHOUT_ENABLE_TLS_IS_TRUE", "MARKETPLACE_PAYMENT_INFO_COLLISION", "ACCOUNT_MARKETPLACE_IS_NOT_ACTIVE", @@ -15257,8 +15277,9 @@ }, "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 get a list of available Redis versions.", - "example": "7.2" + "description": "Optional. Defines the Redis version of the databases created in this specific request. It doesn't determine future databases associated with this subscription. If not set, databases will use the default Redis version. This field is deprecated and will be removed in a future API version - use the database-level redisVersion property instead.", + "example": "7.2", + "deprecated": true }, "commandType": { "type": "string", From 0f7bce619593ed80df0d5a7c610eccb63fabcf81 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Mon, 8 Sep 2025 01:55:47 +0000 Subject: [PATCH 09/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 2109 +++++++++++++---- 1 file changed, 1617 insertions(+), 492 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index a64a2ce2e1..6fd9665605 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -99,12 +99,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -165,12 +165,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -227,12 +227,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -291,12 +291,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -357,12 +357,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -419,12 +419,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -503,12 +503,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -575,12 +575,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -650,12 +650,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -724,12 +724,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -798,12 +798,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -893,12 +893,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -976,12 +976,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -1062,12 +1062,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -1147,12 +1147,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -1251,12 +1251,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -1343,12 +1343,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -1433,12 +1433,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -1505,12 +1505,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -1599,12 +1599,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -1681,12 +1681,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -1771,12 +1771,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -1843,12 +1843,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -1907,12 +1907,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -1973,12 +1973,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -2049,12 +2049,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -2142,12 +2142,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -2214,12 +2214,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -2288,12 +2288,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -2364,12 +2364,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -2446,12 +2446,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -2542,12 +2542,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -2624,12 +2624,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -2728,12 +2728,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -2812,12 +2812,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -2876,12 +2876,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -2942,12 +2942,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -3027,12 +3027,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -3091,12 +3091,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -3156,12 +3156,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -3218,12 +3218,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -3294,12 +3294,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -3383,13 +3383,13 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "400": { "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" }, - "200": { + "412": { + "description": "Precondition Failed - Feature flag for this flow is off" + }, + "200": { "description": "OK", "content": { "application/json": { @@ -3455,12 +3455,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -3529,12 +3529,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -3605,12 +3605,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -3687,12 +3687,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -3783,12 +3783,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -3865,12 +3865,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -3930,12 +3930,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -3997,12 +3997,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -4060,12 +4060,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -4125,12 +4125,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -4191,12 +4191,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -4253,12 +4253,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -4327,12 +4327,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -4389,12 +4389,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -4463,12 +4463,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -4525,12 +4525,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -4577,12 +4577,12 @@ "description": "Gets a list of all Pro subscriptions in the current account.", "operationId": "getAllSubscriptions", "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -4673,12 +4673,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -4740,12 +4740,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -4806,12 +4806,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -4878,12 +4878,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -4952,12 +4952,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -5018,12 +5018,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -5093,12 +5093,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -5177,12 +5177,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -5263,12 +5263,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -5309,14 +5309,14 @@ } } }, - "/subscriptions/{subscriptionId}/regions/peerings": { + "/subscriptions/{subscriptionId}/regions/{regionId}/private-link": { "get": { "tags": [ "Subscriptions - Pro - Connectivity" ], - "summary": "Get Active-Active VPC peering details", - "description": "(Active-Active subscriptions only) Gets VPC peering details for an Active-Active subscription.", - "operationId": "getActiveActiveVpcPeerings", + "summary": "Get Private Link configuration for a specific region", + "description": "(Active-Active subscriptions only) Gets the Private Link configuration for a specific region.", + "operationId": "getActiveActivePrivateLink", "parameters": [ { "name": "subscriptionId", @@ -5327,17 +5327,28 @@ "type": "integer", "format": "int32" } + }, + { + "name": "regionId", + "in": "path", + "description": "Region ID - required for Active-Active subscription", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 1 } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "400": { "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" }, - "200": { - "description": "OK", + "412": { + "description": "Precondition Failed - Feature flag for this flow is off" + }, + "202": { + "description": "Accepted", "content": { "application/json": { "schema": { @@ -5370,9 +5381,9 @@ "tags": [ "Subscriptions - Pro - Connectivity" ], - "summary": "Create Active-Active VPC peering", - "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", + "summary": "Create a Private Link for a specific region", + "description": "(Active-Active subscriptions only) Creates a new Private Link for a specific region.", + "operationId": "createActiveActivePrivateLink", "parameters": [ { "name": "subscriptionId", @@ -5383,37 +5394,38 @@ "type": "integer", "format": "int32" } + }, + { + "name": "regionId", + "in": "path", + "description": "Region ID - required for Active-Active subscription", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActiveActiveVpcPeeringCreateBaseRequest" - }, - "example": { - "provider": "string", - "region": "us-east-1", - "awsAccountId": "", - "vpcId": "", - "vpcCidrs": [ - "<10.10.10.0/24>", - "<10.10.20.0/24>" - ] + "$ref": "#/components/schemas/PrivateLinkActiveActiveCreateRequest" } } }, "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "400": { "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" }, - "200": { - "description": "OK", + "412": { + "description": "Precondition Failed - Feature flag for this flow is off" + }, + "204": { + "description": "No Content", "content": { "application/json": { "schema": { @@ -5452,14 +5464,14 @@ } } }, - "/subscriptions/{subscriptionId}/private-service-connect": { - "get": { + "/subscriptions/{subscriptionId}/regions/{regionId}/private-link/principals": { + "post": { "tags": [ "Subscriptions - Pro - Connectivity" ], - "summary": "Get Private Service Connect", - "description": "Gets Private Service Connect details for a subscription.", - "operationId": "getPscService", + "summary": "Add principal to Private Link for a specific region", + "description": "(Active-Active subscriptions only) Adds a principal (AWS ARN) to the Private Link configuration for a specific region.", + "operationId": "createActiveActivePrivateLinkPrincipal", "parameters": [ { "name": "subscriptionId", @@ -5470,17 +5482,38 @@ "type": "integer", "format": "int32" } + }, + { + "name": "regionId", + "in": "path", + "description": "Region ID - required for Active-Active subscription", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 1 } ], - "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PrivateLinkActiveActivePrincipalsCreateRequest" + } + } }, + "required": true + }, + "responses": { "400": { "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" }, - "202": { - "description": "Accepted", + "412": { + "description": "Precondition Failed - Feature flag for this flow is off" + }, + "204": { + "description": "No Content", "content": { "application/json": { "schema": { @@ -5493,13 +5526,371 @@ "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)" + "description": "Forbidden - Not allowed to create requested resource (primarily due to not active resource)" }, "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)" + "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 the new name" + }, + "422": { + "description": "Unprocessable Entity - The server understands the request, and the syntax of the request is correct, but it was unable to process the contained instructions" + }, + "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 " + } + } + }, + "delete": { + "tags": [ + "Subscriptions - Pro - Connectivity" + ], + "summary": "Remove a principal from Private Link for a specific region", + "description": "(Active-Active subscriptions only) Removes one principal (AWS ARNs) from the Private Link configuration for a specific region.", + "operationId": "deleteActiveActivePrivateLinkPrincipals", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription ID.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "regionId", + "in": "path", + "description": "Region ID - required for Active-Active subscription", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 1 + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PrivateLinkActiveActivePrincipalsDeleteRequest" + } + } + }, + "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" + }, + "204": { + "description": "No Content", + "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}/regions/peerings": { + "get": { + "tags": [ + "Subscriptions - Pro - Connectivity" + ], + "summary": "Get Active-Active VPC peering details", + "description": "(Active-Active subscriptions only) Gets VPC peering details for an Active-Active subscription.", + "operationId": "getActiveActiveVpcPeerings", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription 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/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" + }, + "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": [ + "Subscriptions - Pro - Connectivity" + ], + "summary": "Create Active-Active VPC peering", + "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": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription ID.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActiveActiveVpcPeeringCreateBaseRequest" + }, + "example": { + "provider": "string", + "region": "us-east-1", + "awsAccountId": "", + "vpcId": "", + "vpcCidrs": [ + "<10.10.10.0/24>", + "<10.10.20.0/24>" + ] + } + } + }, + "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 create requested resource (primarily due to not active resource)" + }, + "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 the new name" + }, + "422": { + "description": "Unprocessable Entity - The server understands the request, and the syntax of the request is correct, but it was unable to process the contained instructions" + }, + "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}/private-service-connect": { + "get": { + "tags": [ + "Subscriptions - Pro - Connectivity" + ], + "summary": "Get Private Service Connect", + "description": "Gets Private Service Connect details for a subscription.", + "operationId": "getPscService", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription 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" + }, + "202": { + "description": "Accepted", + "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" + }, + "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": [ + "Subscriptions - Pro - Connectivity" + ], + "summary": "Set up Private Service Connect for a subscription", + "description": "Sets up Google Cloud Private Service Connect for an existing subscription hosted on Google Cloud.", + "operationId": "createPscService", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription 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" + }, + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaskStateUpdate" + } + } + } + }, + "401": { + "description": "Unauthorized - Authentication failed for requested resource" + }, + "403": { + "description": "Forbidden - Not allowed to create requested resource (primarily due to not active resource)" + }, + "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 the new name" + }, + "422": { + "description": "Unprocessable Entity - The server understands the request, and the syntax of the request is correct, but it was unable to process the contained instructions" + }, + "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" @@ -5509,13 +5900,77 @@ } } }, - "post": { + "delete": { "tags": [ "Subscriptions - Pro - Connectivity" ], - "summary": "Set up Private Service Connect for a subscription", - "description": "Sets up Google Cloud Private Service Connect for an existing subscription hosted on Google Cloud.", - "operationId": "createPscService", + "summary": "Remove Private Service Connect for a subscription", + "description": "Deletes Private Service Connect for a subscription.", + "operationId": "deletePscService", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription 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" + }, + "202": { + "description": "Accepted", + "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}/private-service-connect/{pscServiceId}": { + "get": { + "tags": [ + "Subscriptions - Pro - Connectivity" + ], + "summary": "Get Private Service Connect endpoints", + "description": "Gets endpoint details for the specified Private Service Connect.", + "operationId": "getPscServiceEndpoints", "parameters": [ { "name": "subscriptionId", @@ -5526,15 +5981,101 @@ "type": "integer", "format": "int32" } + }, + { + "name": "pscServiceId", + "in": "path", + "description": "Private Service Connect service 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" }, + "202": { + "description": "Accepted", + "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" + }, + "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": [ + "Subscriptions - Pro - Connectivity" + ], + "summary": "Create a Private Service Connect endpoint", + "description": "Creates a new Private Service Connect endpoint.", + "operationId": "createPscServiceEndpoint", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription ID.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pscServiceId", + "in": "path", + "description": "Private Service Connect service ID.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PscEndpointCreateRequest" + } + } + }, + "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" + }, "202": { "description": "Accepted", "content": { @@ -5573,14 +6114,16 @@ "description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support " } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/private-link": { + "get": { "tags": [ "Subscriptions - Pro - Connectivity" ], - "summary": "Remove Private Service Connect for a subscription", - "description": "Deletes Private Service Connect for a subscription.", - "operationId": "deletePscService", + "summary": "Get Private Link configuration", + "description": "Gets the Private Link configuration for a subscription.", + "operationId": "getPrivateLink", "parameters": [ { "name": "subscriptionId", @@ -5594,12 +6137,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -5619,11 +6162,80 @@ "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": [ + "Subscriptions - Pro - Connectivity" + ], + "summary": "Create a Private Link", + "description": "Creates a new Private Link.", + "operationId": "createPrivateLink", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription ID.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PrivateLinkCreateRequest" + } + } + }, + "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" + }, + "204": { + "description": "No Content", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaskStateUpdate" + } + } + } + }, + "401": { + "description": "Unauthorized - Authentication failed for requested resource" + }, + "403": { + "description": "Forbidden - Not allowed to create requested resource (primarily due to not active resource)" + }, + "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)" + "409": { + "description": "Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with the new name" + }, + "422": { + "description": "Unprocessable Entity - The server understands the request, and the syntax of the request is correct, but it was unable to process the contained instructions" }, "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)" @@ -5637,14 +6249,14 @@ } } }, - "/subscriptions/{subscriptionId}/private-service-connect/{pscServiceId}": { - "get": { + "/subscriptions/{subscriptionId}/private-link/principals": { + "post": { "tags": [ "Subscriptions - Pro - Connectivity" ], - "summary": "Get Private Service Connect endpoints", - "description": "Gets endpoint details for the specified Private Service Connect.", - "operationId": "getPscServiceEndpoints", + "summary": "Add principal to Private Link", + "description": "Adds a principal (AWS ARN) to the Private Link configuration.", + "operationId": "createPrivateLinkPrincipal", "parameters": [ { "name": "subscriptionId", @@ -5655,27 +6267,27 @@ "type": "integer", "format": "int32" } - }, - { - "name": "pscServiceId", - "in": "path", - "description": "Private Service Connect service ID.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } } ], - "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PrivateLinkPrincipalsCreateRequest" + } + } }, + "required": true + }, + "responses": { "400": { "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" }, - "202": { - "description": "Accepted", + "412": { + "description": "Precondition Failed - Feature flag for this flow is off" + }, + "204": { + "description": "No Content", "content": { "application/json": { "schema": { @@ -5688,11 +6300,20 @@ "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)" + "description": "Forbidden - Not allowed to create requested resource (primarily due to not active resource)" }, "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 the new name" + }, + "422": { + "description": "Unprocessable Entity - The server understands the request, and the syntax of the request is correct, but it was unable to process the contained instructions" + }, "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)" }, @@ -5704,13 +6325,13 @@ } } }, - "post": { + "delete": { "tags": [ "Subscriptions - Pro - Connectivity" ], - "summary": "Create a Private Service Connect endpoint", - "description": "Creates a new Private Service Connect endpoint.", - "operationId": "createPscServiceEndpoint", + "summary": "Remove a principal from Private Link", + "description": "Removes a principal (AWS ARNs) from the Private Link configuration.", + "operationId": "deletePrivateLinkPrincipals", "parameters": [ { "name": "subscriptionId", @@ -5721,37 +6342,27 @@ "type": "integer", "format": "int32" } - }, - { - "name": "pscServiceId", - "in": "path", - "description": "Private Service Connect service ID.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PscEndpointCreateRequest" + "$ref": "#/components/schemas/PrivateLinkPrincipalsDeleteRequest" } } }, "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "400": { "description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error" }, - "202": { - "description": "Accepted", + "412": { + "description": "Precondition Failed - Feature flag for this flow is off" + }, + "204": { + "description": "No Content", "content": { "application/json": { "schema": { @@ -5764,7 +6375,7 @@ "description": "Unauthorized - Authentication failed for requested resource" }, "403": { - "description": "Forbidden - Not allowed to create requested resource (primarily due to not active resource)" + "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" @@ -5773,10 +6384,7 @@ "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 the new name" - }, - "422": { - "description": "Unprocessable Entity - The server understands the request, and the syntax of the request is correct, but it was unable to process the contained instructions" + "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)" @@ -5811,12 +6419,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -5888,12 +6496,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -5978,12 +6586,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -6062,12 +6670,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -6139,12 +6747,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -6215,12 +6823,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -6289,12 +6897,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -6365,12 +6973,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -6448,12 +7056,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -6523,12 +7131,12 @@ } }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -6575,12 +7183,12 @@ "description": "Gets a list of all Essentials subscriptions in the current account.", "operationId": "getAllSubscriptions_1", "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -6629,12 +7237,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -6719,12 +7327,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -6798,12 +7406,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -6875,12 +7483,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -6951,12 +7559,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7025,12 +7633,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7100,12 +7708,12 @@ } }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7152,12 +7760,12 @@ "description": "Gets a list of all configured cloud accounts.", "operationId": "getCloudAccounts", "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7206,12 +7814,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -7261,12 +7869,12 @@ "description": "Gets a list of all access control users for this account.", "operationId": "getAllUsers_1", "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7315,12 +7923,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -7370,12 +7978,12 @@ "description": "Gets a list of all database access roles for this account.", "operationId": "getRoles", "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7424,12 +8032,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -7479,12 +8087,12 @@ "description": "Gets a list of all Redis ACL rules for this account.", "operationId": "getAllRedisRules", "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7533,12 +8141,12 @@ "required": true }, "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -7588,12 +8196,12 @@ "description": "Gets a list of all account users.", "operationId": "getAllUsers", "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7634,12 +8242,12 @@ "description": "Gets a list of all currently running tasks for this account.", "operationId": "getAllTasks", "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7691,12 +8299,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7749,12 +8357,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7807,12 +8415,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7876,12 +8484,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -7945,12 +8553,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -8033,12 +8641,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -8121,12 +8729,80 @@ } ], "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" }, + "202": { + "description": "Accepted", + "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" + }, + "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}/regions/{regionId}/private-link/endpoint-script": { + "get": { + "tags": [ + "Subscriptions - Pro - Connectivity" + ], + "summary": "Get Private Link endpoint script for a single region", + "description": "(Active-Active subscriptions only) Gets the Private Link endpoint script for a single region in an Active-Active subscription.", + "operationId": "getActiveActivePrivateLinkEndpointScript", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription ID.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "regionId", + "in": "path", + "description": "Region ID - required for Active-Active subscription", + "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" + }, "202": { "description": "Accepted", "content": { @@ -8199,12 +8875,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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" + }, "202": { "description": "Accepted", "content": { @@ -8277,12 +8953,70 @@ } ], "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" }, + "202": { + "description": "Accepted", + "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" + }, + "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}/private-link/endpoint-script": { + "get": { + "tags": [ + "Subscriptions - Pro - Connectivity" + ], + "summary": "Get Private Link endpoint script", + "description": "Gets the Python discovery script for Private Link. Internal users can optionally request a Terraform snippet.", + "operationId": "getPrivateLinkEndpointScript", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription 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" + }, "202": { "description": "Accepted", "content": { @@ -8335,12 +9069,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -8412,12 +9146,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -8482,12 +9216,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -8540,12 +9274,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -8609,15 +9343,35 @@ "format": "int32" }, "example": 100 + }, + { + "name": "startTime", + "in": "query", + "description": "Filter session logs with time >= startTime (UTC)", + "required": false, + "schema": { + "type": "string" + }, + "example": "2025-01-01T00:00:00Z" + }, + { + "name": "endTime", + "in": "query", + "description": "Filter session logs with time <= endTime (UTC)", + "required": false, + "schema": { + "type": "string" + }, + "example": "2025-01-31T23:59:59Z" } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -8673,12 +9427,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -8719,12 +9473,12 @@ "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": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -8765,12 +9519,12 @@ "description": "Gets a list of all payment methods for this account.", "operationId": "getAccountPaymentMethods", "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -8834,15 +9588,46 @@ "format": "int32" }, "example": 100 + }, + { + "name": "startTime", + "in": "query", + "description": "Filter logs with time >= startTime (UTC)", + "required": false, + "schema": { + "type": "string" + }, + "example": "2025-01-01T00:00:00Z" + }, + { + "name": "endTime", + "in": "query", + "description": "Filter logs with time <= endTime (UTC)", + "required": false, + "schema": { + "type": "string" + }, + "example": "2025-01-31T23:59:59Z" + }, + { + "name": "resourceId", + "in": "query", + "description": "Filter logs by resourceId", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 1234 } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -8905,12 +9690,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -8963,12 +9748,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -9034,12 +9819,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -9092,12 +9877,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -9150,12 +9935,12 @@ } ], "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -9196,12 +9981,12 @@ "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": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -9242,12 +10027,12 @@ "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": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -9288,12 +10073,12 @@ "description": "Gets information on this account.", "operationId": "getCurrentAccount", "responses": { - "412": { - "description": "Precondition Failed - Feature flag for this flow is off" - }, "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": { @@ -9344,12 +10129,12 @@ "role": { "type": "string", "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" + "example": "ACL-role-example" }, "password": { "type": "string", "description": "The database password for this user.", - "example": "some-random-password" + "example": "ab123AB$%^" }, "commandType": { "type": "string", @@ -9518,7 +10303,7 @@ "example": { "account": { "id": 1001, - "name": "Redis Labs", + "name": "Redis", "createdTimestamp": "2018-12-23T15:15:31Z", "updatedTimestamp": "2022-10-12T10:54:10Z", "pocStatus": "inactive", @@ -9526,7 +10311,7 @@ "key": { "name": "capi-api-key-name", "accountId": 1001, - "accountName": "Redis Labs", + "accountName": "Redis", "allowedSourceIps": [ "0.0.0.0/0" ], @@ -9541,6 +10326,64 @@ } } }, + "PrivateLinkActiveActiveCreateRequest": { + "required": [ + "principal", + "regionId", + "shareName", + "type" + ], + "type": "object", + "properties": { + "subscriptionId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "regionId": { + "type": "integer", + "description": "Deployment region id as defined by cloud provider", + "format": "int32", + "readOnly": true, + "example": 27 + }, + "shareName": { + "maxLength": 64, + "minLength": 0, + "type": "string", + "description": "Name for the resource share", + "example": "my-private-link-share" + }, + "principal": { + "type": "string", + "description": "AWS account ID or ARN of the principal (IAM user, role, or account)", + "example": "123456789012" + }, + "type": { + "type": "string", + "description": "Type of the principal", + "example": "aws_account", + "enum": [ + "aws_account", + "organization", + "organization_unit", + "iam_role", + "iam_user", + "service_principal" + ] + }, + "alias": { + "type": "string", + "description": "Alias or friendly name for the principal", + "example": "Production Account" + }, + "commandType": { + "type": "string", + "readOnly": true + } + }, + "description": "Request to create a private link for Active-Active subscription" + }, "ActiveActiveVpcPeeringCreateAwsRequest": { "required": [ "awsAccountId", @@ -9878,6 +10721,12 @@ "memcached" ] }, + "port": { + "type": "integer", + "description": "Optional. TCP port on which the database is available (10000-19999). Generated automatically if not set.", + "format": "int32", + "example": 10000 + }, "memoryLimitInGb": { "minimum": 0.1, "exclusiveMinimum": false, @@ -10531,6 +11380,10 @@ "resp2", "resp3" ] + }, + "enableDefaultUser": { + "type": "boolean", + "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." } }, "description": "Optional. A list of regions and local settings to update." @@ -10966,7 +11819,7 @@ "cloudAccounts": [ { "id": 1, - "name": "Redis Labs Internal Resources", + "name": "Redis Internal Resources", "provider": "AWS", "status": "active", "links": [] @@ -10997,6 +11850,55 @@ ] } }, + "PrivateLinkActiveActivePrincipalsCreateRequest": { + "required": [ + "principal", + "regionId" + ], + "type": "object", + "properties": { + "subscriptionId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "regionId": { + "type": "integer", + "description": "Deployment region id as defined by cloud provider", + "format": "int32", + "readOnly": true, + "example": 27 + }, + "principal": { + "type": "string", + "description": "AWS account ID or ARN of the principal (IAM user, role, or account)", + "example": "123456789012" + }, + "type": { + "type": "string", + "description": "Type of the principal", + "example": "aws_account", + "enum": [ + "aws_account", + "organization", + "organization_unit", + "iam_role", + "iam_user", + "service_principal" + ] + }, + "alias": { + "type": "string", + "description": "Alias or friendly name for the principal", + "example": "Production Account" + }, + "commandType": { + "type": "string", + "readOnly": true + } + }, + "description": "Request to add a principal to private link for Active-Active subscription" + }, "VpcPeeringUpdateAwsRequest": { "type": "object", "properties": { @@ -11196,7 +12098,8 @@ }, "redisRule": { "type": "string", - "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." + "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.", + "example": "+set allkeys allchannels" }, "commandType": { "type": "string", @@ -11246,6 +12149,12 @@ "signInLoginUrl": { "type": "string" }, + "awsUserArn": { + "type": "string" + }, + "awsConsoleRoleArn": { + "type": "string" + }, "links": { "type": "array", "items": { @@ -11266,7 +12175,7 @@ "description": "RedisLabs Cloud Account information", "example": { "id": 1, - "name": "Redis Labs Internal Resources", + "name": "Redis Internal Resources", "provider": "AWS", "status": "active", "links": [ @@ -11278,6 +12187,47 @@ ] } }, + "PrivateLinkPrincipalsCreateRequest": { + "required": [ + "principal" + ], + "type": "object", + "properties": { + "subscriptionId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "principal": { + "type": "string", + "description": "AWS account ID or ARN of the principal (IAM user, role, or account)", + "example": "123456789012" + }, + "type": { + "type": "string", + "description": "Type of the principal", + "example": "aws_account", + "enum": [ + "aws_account", + "organization", + "organization_unit", + "iam_role", + "iam_user", + "service_principal" + ] + }, + "alias": { + "type": "string", + "description": "Alias or friendly name for the principal", + "example": "Production Account" + }, + "commandType": { + "type": "string", + "readOnly": true + } + }, + "description": "Private Link principals create request" + }, "FixedSubscriptionUpdateRequest": { "type": "object", "properties": { @@ -11832,6 +12782,10 @@ "resource": { "type": "string" }, + "resourceId": { + "type": "integer", + "format": "int32" + }, "type": { "type": "string" }, @@ -12144,7 +13098,7 @@ "time": "2022-10-12T10:54:31Z", "originator": "example-value", "type": "Account", - "description": "example-value (example.value@redislabs.com)'s user name was changed to Example Value" + "description": "example-value (example.value@redis.com)'s user name was changed to Example Value" }, { "id": 2900348, @@ -13709,17 +14663,14 @@ "subnetIds": { "type": "array", "description": "Optional. Enter a list of subnets identifiers that exists in the hosted AWS account. Subnet Identifier must exist within the hosting account.", - "example": "", "items": { "type": "string", - "description": "Optional. Enter a list of subnets identifiers that exists in the hosted AWS account. Subnet Identifier must exist within the hosting account.", - "example": "" + "description": "Optional. Enter a list of subnets identifiers that exists in the hosted AWS account. Subnet Identifier must exist within the hosting account." } }, "securityGroupId": { "type": "string", - "description": "Optional. Enter a security group identifier that exists in the hosted AWS account. Security group Identifier must be in a valid format (for example: 'sg-0125be68a4625884ad') and must exist within the hosting account.", - "example": "" + "description": "Optional. Enter a security group identifier that exists in the hosted AWS account. Security group Identifier must be in a valid format (for example: 'sg-0125be68a4625884ad') and must exist within the hosting account." } }, "description": "Optional. Cloud networking details, per region. Required if creating an Active-Active subscription." @@ -13921,7 +14872,8 @@ }, "redisRule": { "type": "string", - "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." + "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.", + "example": "+set allkeys allchannels" }, "commandType": { "type": "string", @@ -14251,12 +15203,12 @@ "role": { "type": "string", "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" + "example": "ACL-role-example" }, "password": { "type": "string", "description": "Optional. Changes the user's database password.", - "example": "some-random-password" + "example": "ab123AB$%^" }, "commandType": { "type": "string", @@ -14300,14 +15252,15 @@ "SUBSCRIPTION_IN_USE", "SUBSCRIPTION_CA_PROVIDER_MISMATCH", "SUBSCRIPTION_NETWORKING_MISSING", - "SUBSCRIPTION_NETWORKING_CIDR_MISSING", + "NETWORKING_CIDR_MISSING", "SUBSCRIPTION_INVALID_CIDR", - "SUBSCRIPTION_NETWORKING_SECURITY_GROUP_MISSING", - "SUBSCRIPTION_NETWORKING_SUBNET_IDS_MISSING", - "SUBSCRIPTION_NETWORKING_VPC_ID_MISSING", - "SUBSCRIPTION_NETWORKING_CIDR_IS_NOT_SUPPORTED", - "SUBSCRIPTION_NETWORKING_VPC_WITH_SUBNETS_AND_SECURITY_GROUP_IS_NOT_SUPPORTED", - "SUBSCRIPTION_INVALID_NUMBER_OF_SUBNET_IDS", + "NETWORKING_SECURITY_GROUP_MISSING", + "NETWORKING_SUBNET_IDS_MISSING", + "NETWORKING_VPC_ID_MISSING", + "NETWORKING_CIDR_IS_NOT_SUPPORTED", + "NETWORKING_VPC_WITH_SUBNETS_AND_SECURITY_GROUP_IS_NOT_SUPPORTED", + "NETWORKING_VPC_WITH_SUBNETS_AND_SECURITY_GROUP_IS_NOT_SUPPORTED_FOR_INTERNAL_CLOUD_ACCOUNT", + "INVALID_NUMBER_OF_SUBNET_IDS", "SUBSCRIPTION_PI_NOT_FOUND", "SUBSCRIPTION_INVALID_REGION_NAME", "SUBSCRIPTION_INVALID_REGION_ID", @@ -14330,6 +15283,9 @@ "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_DISABLED_KEY", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_INVALID_KEY_NAME", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_WRONG_REGION", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_NOT_ALLOWED_WITH_CLOUD_PROVIDER_MANAGED_KEY", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_NOT_ALLOWED_WITH_INTERNAL_CLOUD_ACCOUNT", + "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_REQUIRED_FOR_EXTERNAL_CLOUD_ACCOUNT", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_NOT_PENDING", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_INVALID_NUMBER_OF_KEYS", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_REGION_NOT_REQUIRED", @@ -14473,11 +15429,13 @@ "DATABASE_PORT_INVALID_VALUE", "DATABASE_PORT_IS_UNAVAILABLE", "DATABASE_CUSTOM_PORT_NOT_SUPPORTED", + "DATABASE_CUSTOM_PORT_NOT_UNIQUE", "DATABASE_AVERAGE_ITEM_SIZE_INVALID_VALUE", "DATABASE_REDIS_VERSION_IS_NOT_SUPPORTED", "DATABASE_REDIS_VERSION_IS_NOT_SUPPORTED_FOR_MEMCACHED", "DATABASE_REDIS_VERSION_IS_REQUIRED", "DATABASE_REDIS_VERSION_INVALID_VALUE", + "CONNECTIVITY_REQUESTS_ON_CUSTOMER_MANAGED_VPC_SUBSCRIPTION", "VPC_PEERING_NOT_ACTIVE", "VPC_PEERING_GENERAL_ERROR", "VPC_PEERING_INVALID_ACCOUNT", @@ -14817,7 +15775,23 @@ "ACTIVE_ACTIVE_GCP_EXTERNAL_CLOUD_ACCOUNT_NOT_SUPPORTED", "DEDICATED_SUBSCRIPTION_PREFERRED_AZ_INVALID_VALUE", "DEDICATED_SUBSCRIPTION_INVALID_INSTANCE_NAME", - "DEDICATED_SUBSCRIPTION_INVALID_REPLICATION" + "DEDICATED_SUBSCRIPTION_INVALID_REPLICATION", + "PRIVATE_LINK_NOT_FOUND", + "PRIVATE_LINK_ALREADY_EXISTS", + "PRIVATE_LINK_PRINCIPAL_ALREADY_EXISTS", + "PRIVATE_LINK_PRINCIPAL_NOT_FOUND", + "PRIVATE_LINK_PRINCIPAL_INVALID_PRINCIPLE", + "PRIVATE_LINK_CLOUD_PROVIDER_NOT_SUPPORTED", + "PRIVATE_LINK_GET_A_FLEXIBLE_SUBSCRIPTION_PRIVATE_LINK_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION", + "PRIVATE_LINK_GET_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_LINK_IS_NOT_ALLOWED_WITH_A_SINGLE_REGION_SUBSCRIPTION", + "PRIVATE_LINK_CREATING_PRINCIPLES_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION", + "PRIVATE_LINK_CREATING_PRINCIPLES_IS_NOT_ALLOWED_WITH_A_SINGLE_REGION_SUBSCRIPTION", + "PRIVATE_LINK_DELETING_A_FLEXIBLE_SUBSCRIPTION_PRINCIPALS_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION", + "PRIVATE_LINK_DELETING_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRINCIPALS_IS_NOT_ALLOWED_WITH_A_SINGLE_REGION_SUBSCRIPTION", + "PRIVATE_LINK_CREATE_A_FLEXIBLE_SUBSCRIPTION_PRIVATE_LINK_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION", + "PRIVATE_LINK_CREATE_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_LINK_IS_NOT_ALLOWED_WITH_A_SINGLE_REGION_SUBSCRIPTION", + "PRIVATE_LINK_IS_NOT_SUPPORTED", + "PRIVATE_LINK_SERVICE_ERROR" ] }, "additionalInfo": { @@ -15261,6 +16235,9 @@ "customer-managed-key" ] }, + "persistentStorageEncryptionKeys": { + "$ref": "#/components/schemas/CustomerManagedKeyProperties" + }, "cloudProviders": { "type": "array", "description": "Cloud provider, region, and networking details.", @@ -15350,6 +16327,56 @@ }, "description": "Cloud Account definition" }, + "PrivateLinkCreateRequest": { + "required": [ + "principal", + "shareName", + "type" + ], + "type": "object", + "properties": { + "subscriptionId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "shareName": { + "maxLength": 64, + "minLength": 0, + "type": "string", + "description": "Name of the resource share", + "example": "my-redis-share" + }, + "principal": { + "type": "string", + "description": "AWS account ID or ARN of the principal (IAM user, role, or account)", + "example": "123456789012" + }, + "type": { + "type": "string", + "description": "Type of the principal", + "example": "aws_account", + "enum": [ + "aws_account", + "organization", + "organization_unit", + "iam_role", + "iam_user", + "service_principal" + ] + }, + "alias": { + "type": "string", + "description": "Alias or friendly name for the principal", + "example": "Production Account" + }, + "commandType": { + "type": "string", + "readOnly": true + } + }, + "description": "Private Link create request" + }, "SubscriptionPricings": { "type": "object", "properties": { @@ -15408,6 +16435,37 @@ }, "description": "Optional. Changes Replica Of (also known as Active-Passive) configuration details." }, + "PrivateLinkActiveActivePrincipalsDeleteRequest": { + "required": [ + "principal", + "regionId" + ], + "type": "object", + "properties": { + "subscriptionId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "regionId": { + "type": "integer", + "description": "Deployment region id as defined by cloud provider", + "format": "int32", + "readOnly": true, + "example": 27 + }, + "principal": { + "type": "string", + "description": "An AWS account ID or ARN to remove from the private link", + "example": "123456789012" + }, + "commandType": { + "type": "string", + "readOnly": true + } + }, + "description": "Request to remove principals from private link for Active-Active subscription" + }, "DatabaseThroughputSpec": { "required": [ "by", @@ -15745,9 +16803,6 @@ "description": "Object representing a customer managed key (CMK), along with the region it is associated to." }, "ActiveActiveRegionCreateRequest": { - "required": [ - "deploymentCIDR" - ], "type": "object", "properties": { "subscriptionId": { @@ -15769,6 +16824,21 @@ "description": "Deployment CIDR mask. Must be a valid CIDR format with a range of 256 IP addresses.", "example": "10.0.0.0/24" }, + "subnetIds": { + "type": "array", + "description": "Optional. Enter a list of subnets identifiers that exists in the hosted AWS account. Subnet Identifier must exist within the hosting account.", + "example": "['subnet-0125be68a4625884ad', 'subnet-0125be68a4625884ad','subnet-0125be68a4625884ad']", + "items": { + "type": "string", + "description": "Optional. Enter a list of subnets identifiers that exists in the hosted AWS account. Subnet Identifier must exist within the hosting account.", + "example": "['subnet-0125be68a4625884ad', 'subnet-0125be68a4625884ad','subnet-0125be68a4625884ad']" + } + }, + "securityGroupId": { + "type": "string", + "description": "Optional. Enter a security group identifier that exists in the hosted AWS account. Security group Identifier must be in a valid format (for example: 'sg-0125be68a4625884ad') and must exist within the hosting account.", + "example": "sg-0125be68a4625884ad" + }, "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, and does not create any resources. Default: 'false'", @@ -15848,6 +16918,61 @@ }, "description": "Database import request" }, + "PrivateLinkPrincipalsDeleteRequest": { + "required": [ + "principal" + ], + "type": "object", + "properties": { + "subscriptionId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "principal": { + "type": "string", + "description": "An AWS account ID or ARN to remove from the private link", + "example": "123456789012" + }, + "commandType": { + "type": "string", + "readOnly": true + } + }, + "description": "Private Link principals delete request" + }, + "CustomerManagedKeyProperties": { + "required": [ + "customerManagedKeys" + ], + "type": "object", + "properties": { + "customerManagedKeys": { + "type": "array", + "description": "The customer managed keys (CMK) to use for this subscription. If is active-active subscription, must set a key for each region.", + "items": { + "$ref": "#/components/schemas/CustomerManagedKey" + } + }, + "deletionGracePeriod": { + "type": "string", + "description": "Optional. The grace period for deleting the subscription. If not set, will default to immediate deletion grace period.", + "example": "alerts-only", + "enum": [ + "alerts-only", + "immediate", + "15-minutes", + "30-minutes", + "1-hour", + "4-hours", + "8-hours", + "12-hours", + "24-hours" + ] + } + }, + "description": "Optional. Contains information about the keys used for each region. Can be used only with external cloud account" + }, "VpcPeeringCreateBaseRequest": { "type": "object", "properties": { From f6bba230b3ceaeb3444cdc8c2a9e6bb74899d5cc Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Mon, 22 Sep 2025 01:59:00 +0000 Subject: [PATCH 10/20] Update content/operate/rc/api/api-reference/openapi.json --- content/operate/rc/api/api-reference/openapi.json | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 6fd9665605..cbd8f19922 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -22,7 +22,8 @@ "security": [ { "x-api-key": [], - "x-api-secret-key": [] + "x-api-secret-key": [], + "X-Auth-Token": [] } ], "tags": [ @@ -15359,6 +15360,7 @@ "DATABASE_MODULE_MUST_BE_DEFINED_ONCE", "DATABASE_MEMCACHED_CONTAINS_MODULES", "DATABASE_MEMCACHED_NOT_SUPPORT_OSS_CLUSTER_API", + "REDIS_ON_FLASH_DATABASE_MEMCACHED_PROTOCOL_IS_NOT_ALLOWED", "DATABASE_MEMCACHED_CONTAINS_REDIS_PASSWORD", "DATABASE_MEMCACHED_CONTAINS_REDIS_DEFAULT_USER", "DATABASE_MEMCACHED_SASL_USERNAME_IS_BLANK", @@ -15380,6 +15382,7 @@ "DATABASE_INVALID_MODULE", "DATABASE_INVALID_MODULE_PARAMETER", "DATABASE_INVALID_MODULE_PARAMETER_VALUE", + "DATABASE_EXPLICIT_MODULES_NOT_SUPPORTED_FOR_THIS_REDIS_VERSION", "DATABASE_INVALID_ALERT_VALUE", "DATABASE_SHARDING_TYPE_IS_IMMUTABLE", "DATABASE_SHARDING_TYPE_IS_NOT_SUPPORTED", @@ -17005,6 +17008,11 @@ "type": "apiKey", "name": "x-api-secret-key", "in": "header" + }, + "X-Auth-Token": { + "type": "apiKey", + "name": "X-Auth-Token", + "in": "header" } } } From f4a924fe15fd715c38f8553da6dcc736c19c7acd Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Mon, 6 Oct 2025 01:51:53 +0000 Subject: [PATCH 11/20] Update content/operate/rc/api/api-reference/openapi.json --- content/operate/rc/api/api-reference/openapi.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index cbd8f19922..559494a13a 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -15521,6 +15521,10 @@ "CIDR_WHITELIST_DUPLICATE_CIDRS", "CIDR_WHITELIST_DUPLICATE_SG", "CIDR_WHITELIST_NOT_ALLOWED", + "CLIENT_PUBLIC_ACCESS_INVALID_SOURCE_IPS", + "CLIENT_PUBLIC_ACCESS_NOT_SUPPORTED", + "CLIENT_PUBLIC_ACCESS_ALREADY_SET", + "CLIENT_PUBLIC_ACCESS_ON_NON_HOSTED", "AWS_ERROR_INSTANCE_LIMIT_EXCEEDED", "AWS_ERROR_VPC_LIMIT_EXCEEDED", "AWS_ERROR_INSUFFICIENT_INSTANCE_CAPACITY", From 90c8d605d147f7deeb7deff15e8864ce2adb0a8c Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Thu, 9 Oct 2025 01:50:18 +0000 Subject: [PATCH 12/20] Update content/operate/rc/api/api-reference/openapi.json --- content/operate/rc/api/api-reference/openapi.json | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 559494a13a..e22246bbcc 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -11384,7 +11384,7 @@ }, "enableDefaultUser": { "type": "boolean", - "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." + "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. If set, 'globalEnableDefaultUser' will not apply to this region." } }, "description": "Optional. A list of regions and local settings to update." @@ -14816,6 +14816,10 @@ "type": "string", "description": "Optional. Changes the password used to access the database in all regions that don't set a local 'password'." }, + "globalEnableDefaultUser": { + "type": "boolean", + "description": "Optional. When 'true', allows connecting to the database with the 'default' user in all regions that don't set local 'enableDefaultUser'. When 'false', only defined access control users can connect to the database." + }, "globalSourceIp": { "type": "array", "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']", From 012ed46c77c2326d6f77b8f8a98b1231051fb03a Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Mon, 20 Oct 2025 02:01:23 +0000 Subject: [PATCH 13/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 208 ++++++++++++++++++ 1 file changed, 208 insertions(+) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index e22246bbcc..b456eec938 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -4633,6 +4633,7 @@ "deploymentType": "single-region", "paymentMethod": "credit-card", "paymentMethodId": 12345, + "publicEndpointAccess": true, "memoryStorage": "ram", "cloudProviders": [ { @@ -7453,6 +7454,156 @@ } } }, + "/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/upgrade": { + "get": { + "tags": [ + "Databases - Essentials" + ], + "summary": "Get Essentials database version upgrade status", + "description": "Gets information on the latest upgrade attempt for this Essentials database.", + "operationId": "getEssentialsDatabaseRedisVersionUpgradeStatus", + "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 - Essentials" + ], + "summary": "Upgrade Essentials database version", + "description": "Upgrades the specified Essentials database to a later Redis version.", + "operationId": "upgradeEssentialsDatabaseRedisVersion", + "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/FixedDatabaseUpgradeRedisVersionRequest" + } + } + }, + "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 " + } + } + } + }, "/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/import": { "get": { "tags": [ @@ -10472,6 +10623,10 @@ "marketplace" ] }, + "publicEndpointAccess": { + "type": "boolean", + "description": "Optional. When 'false', all databases on this subscription will reject any connection attempt to the public endpoint and any connection attempt to the private endpoint that does not come from an IP address in the private address space defined in [RFC 1918](https://datatracker.ietf.org/doc/html/rfc1918#section-3 ). You must use a [private connectivity method](https://redis.io/docs/latest/operate/rc/security/database-security/block-public-endpoints/#private-connectivity-methods ) to connect to a database with a blocked public endpoint." + }, "commandType": { "type": "string", "readOnly": true @@ -10766,6 +10921,10 @@ "type": "boolean", "description": "Optional. Databases replication. Default: 'true'" }, + "autoMinorVersionUpgrade": { + "type": "boolean", + "description": "Optional. When 'true', enables auto minor version upgrades for this database. Default: 'true'" + }, "throughputMeasurement": { "$ref": "#/components/schemas/DatabaseThroughputSpec" }, @@ -10842,6 +11001,9 @@ "status": { "type": "string" }, + "publicEndpointAccess": { + "type": "boolean" + }, "memoryStorage": { "type": "string", "enum": [ @@ -10886,6 +11048,7 @@ "status": "active", "deploymentType": "single-region", "paymentMethodId": 2, + "publicEndpointAccess": true, "memoryStorage": "ram", "numberOfDatabases": 6, "paymentMethodType": "credit-card", @@ -11227,6 +11390,10 @@ "type": "boolean", "description": "Optional. Turns database replication on or off." }, + "autoMinorVersionUpgrade": { + "type": "boolean", + "description": "Optional. When 'true', enables auto minor version upgrades for this database." + }, "regexRules": { "type": "array", "description": "Optional. Hashing policy Regex rules. Used only if 'shardingType' is 'custom-regex-rules'.", @@ -13356,6 +13523,7 @@ "status": "active", "deploymentType": "single-region", "paymentMethodId": 123, + "publicEndpointAccess": true, "memoryStorage": "ram", "numberOfDatabases": 6, "paymentMethodType": "credit-card", @@ -14735,6 +14903,34 @@ ] } }, + "FixedDatabaseUpgradeRedisVersionRequest": { + "required": [ + "targetRedisVersion" + ], + "type": "object", + "properties": { + "databaseId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "subscriptionId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "targetRedisVersion": { + "type": "string", + "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": { + "type": "string", + "readOnly": true + } + }, + "description": "Upgrades the specified Essentials database to a later Redis version." + }, "CrdbUpdatePropertiesRequest": { "type": "object", "properties": { @@ -14856,6 +15052,10 @@ "noeviction" ] }, + "autoMinorVersionUpgrade": { + "type": "boolean", + "description": "Optional. When 'true', enables auto minor version upgrades for this database." + }, "commandType": { "type": "string", "readOnly": true @@ -15063,6 +15263,10 @@ "type": "boolean", "description": "Optional. Sets database replication. Default: 'true'" }, + "autoMinorVersionUpgrade": { + "type": "boolean", + "description": "Optional. When 'true', enables auto minor version upgrades for this database. Default: 'true'" + }, "replicaOf": { "type": "array", "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'. If the URI provided is a Redis Cloud database, only host and port should be provided. Example: ['redis://endpoint1:6379', 'redis://endpoint2:6380'].", @@ -16269,6 +16473,10 @@ "example": "7.2", "deprecated": true }, + "publicEndpointAccess": { + "type": "boolean", + "description": "Optional. When 'false', all databases on this subscription will reject any connection attempt to the public endpoint and any connection attempt to the private endpoint that does not come from an IP address in the private address space defined in [RFC 1918](https://datatracker.ietf.org/doc/html/rfc1918#section-3 ). You must use a [private connectivity method](https://redis.io/docs/latest/operate/rc/security/database-security/block-public-endpoints/#private-connectivity-methods ) to connect to a database with a blocked public endpoint. Default: 'true'." + }, "commandType": { "type": "string", "readOnly": true From 849717cc12002d4658367fb4a70a600683b6e6d4 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 01:57:57 +0000 Subject: [PATCH 14/20] Update content/operate/rc/api/api-reference/openapi.json --- content/operate/rc/api/api-reference/openapi.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index b456eec938..96b75653ae 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -17166,13 +17166,6 @@ ], "type": "object", "properties": { - "customerManagedKeys": { - "type": "array", - "description": "The customer managed keys (CMK) to use for this subscription. If is active-active subscription, must set a key for each region.", - "items": { - "$ref": "#/components/schemas/CustomerManagedKey" - } - }, "deletionGracePeriod": { "type": "string", "description": "Optional. The grace period for deleting the subscription. If not set, will default to immediate deletion grace period.", @@ -17188,6 +17181,13 @@ "12-hours", "24-hours" ] + }, + "customerManagedKeys": { + "type": "array", + "description": "The customer managed keys (CMK) to use for this subscription. If is active-active subscription, must set a key for each region.", + "items": { + "$ref": "#/components/schemas/CustomerManagedKey" + } } }, "description": "Optional. Contains information about the keys used for each region. Can be used only with external cloud account" From 410d14cfdcbc0bbcf08ff09517923516f1c25001 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Sat, 25 Oct 2025 01:51:18 +0000 Subject: [PATCH 15/20] Update content/operate/rc/api/api-reference/openapi.json --- content/operate/rc/api/api-reference/openapi.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 96b75653ae..b456eec938 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -17166,6 +17166,13 @@ ], "type": "object", "properties": { + "customerManagedKeys": { + "type": "array", + "description": "The customer managed keys (CMK) to use for this subscription. If is active-active subscription, must set a key for each region.", + "items": { + "$ref": "#/components/schemas/CustomerManagedKey" + } + }, "deletionGracePeriod": { "type": "string", "description": "Optional. The grace period for deleting the subscription. If not set, will default to immediate deletion grace period.", @@ -17181,13 +17188,6 @@ "12-hours", "24-hours" ] - }, - "customerManagedKeys": { - "type": "array", - "description": "The customer managed keys (CMK) to use for this subscription. If is active-active subscription, must set a key for each region.", - "items": { - "$ref": "#/components/schemas/CustomerManagedKey" - } } }, "description": "Optional. Contains information about the keys used for each region. Can be used only with external cloud account" From 09d8db94dd025f38f88521b6cef020724fb1017e Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Tue, 4 Nov 2025 01:57:22 +0000 Subject: [PATCH 16/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 473 +++++++++++++++++- 1 file changed, 455 insertions(+), 18 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index b456eec938..8b03093ae1 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -5464,6 +5464,79 @@ "description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support " } } + }, + "delete": { + "tags": [ + "Subscriptions - Pro - Connectivity" + ], + "summary": "Delete Private Link for a specific region", + "description": "(Active-Active subscriptions only) Deletes the Private Link configuration for a specific region.", + "operationId": "deleteActiveActivePrivateLink", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription ID.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "regionId", + "in": "path", + "description": "Region ID - required for Active-Active subscription", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 1 + } + ], + "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" + }, + "204": { + "description": "No Content", + "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}/regions/{regionId}/private-link/principals": { @@ -6249,6 +6322,68 @@ "description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support " } } + }, + "delete": { + "tags": [ + "Subscriptions - Pro - Connectivity" + ], + "summary": "Delete Private Link", + "description": "Deletes the Private Link configuration for a subscription.", + "operationId": "deletePrivateLink", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription 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" + }, + "204": { + "description": "No Content", + "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}/private-link/principals": { @@ -9405,6 +9540,74 @@ } } }, + "/subscriptions/{subscriptionId}/databases/{databaseId}/available-target-versions": { + "get": { + "tags": [ + "Databases - Pro" + ], + "summary": "Get available upgrade versions for Pro database", + "description": "Gets a list of available Redis versions that the specified Pro database can be upgraded to.", + "operationId": "getDatabaseAvailableVersions", + "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/BdbAvailableVersionsResponse" + } + } + } + }, + "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/redis-versions": { "get": { "tags": [ @@ -9879,6 +10082,74 @@ } } }, + "/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/available-target-versions": { + "get": { + "tags": [ + "Databases - Essentials" + ], + "summary": "Get available upgrade versions for Essentials database", + "description": "Gets a list of available Redis versions that the specified Essentials database can be upgraded to.", + "operationId": "getEssentialsDatabaseAvailableVersions", + "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/BdbAvailableVersionsResponse" + } + } + } + }, + "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/redis-versions": { "get": { "tags": [ @@ -10265,6 +10536,14 @@ }, "components": { "schemas": { + "TargetVersion": { + "type": "object", + "properties": { + "redisVersion": { + "type": "string" + } + } + }, "AclUserCreateRequest": { "required": [ "name", @@ -11682,148 +11961,289 @@ "example": { "regions": [ { + "id": 1, "name": "us-east-1", "provider": "AWS" }, { + "id": 2, "name": "us-west-1", "provider": "AWS" }, { + "id": 3, "name": "us-west-2", "provider": "AWS" }, { + "id": 4, "name": "eu-west-1", "provider": "AWS" }, { + "id": 29, "name": "eu-central-1", "provider": "AWS" }, { - "name": "ap-northeast-1", + "id": 7, + "name": "sa-east-1", "provider": "AWS" }, { - "name": "ap-southeast-1", + "id": 63, + "name": "ca-central-1", "provider": "AWS" }, { - "name": "ap-southeast-2", + "id": 62, + "name": "eu-north-1", "provider": "AWS" }, { - "name": "sa-east-1", + "id": 61, + "name": "eu-west-3", + "provider": "AWS" + }, + { + "id": 60, + "name": "eu-west-2", "provider": "AWS" }, { + "id": 59, "name": "us-east-2", "provider": "AWS" }, { - "name": "eu-west-2", + "id": 64, + "name": "ap-east-1", "provider": "AWS" }, { - "name": "eu-west-3", + "id": 146, + "name": "ap-southeast-5", "provider": "AWS" }, { - "name": "eu-north-1", + "id": 30, + "name": "ap-south-1", "provider": "AWS" }, { - "name": "ca-central-1", + "id": 117, + "name": "ap-northeast-3", "provider": "AWS" }, { - "name": "ap-east-1", + "id": 116, + "name": "ap-northeast-2", "provider": "AWS" }, { - "name": "ap-south-1", + "id": 145, + "name": "ap-southeast-7", + "provider": "AWS" + }, + { + "id": 6, + "name": "ap-northeast-1", "provider": "AWS" }, { + "id": 5, + "name": "ap-southeast-1", + "provider": "AWS" + }, + { + "id": 15, + "name": "ap-southeast-2", + "provider": "AWS" + }, + { + "id": 132, + "name": "il-central-1", + "provider": "AWS" + }, + { + "id": 144, + "name": "mx-central-1", + "provider": "AWS" + }, + { + "id": 32, "name": "asia-east1", "provider": "GCP" }, { + "id": 67, "name": "asia-east2", "provider": "GCP" }, { + "id": 33, "name": "asia-northeast1", "provider": "GCP" }, { + "id": 104, "name": "asia-northeast2", "provider": "GCP" }, { + "id": 69, "name": "asia-south1", "provider": "GCP" }, { + "id": 34, "name": "asia-southeast1", "provider": "GCP" }, { + "id": 71, "name": "australia-southeast1", "provider": "GCP" }, { + "id": 72, "name": "europe-north1", "provider": "GCP" }, { + "id": 35, "name": "europe-west1", "provider": "GCP" }, { + "id": 74, "name": "europe-west2", "provider": "GCP" }, { + "id": 128, + "name": "asia-southeast2", + "provider": "GCP" + }, + { + "id": 75, "name": "europe-west3", "provider": "GCP" }, { + "id": 36, "name": "europe-west4", "provider": "GCP" }, { + "id": 133, + "name": "europe-west10", + "provider": "GCP" + }, + { + "id": 130, + "name": "europe-southwest1", + "provider": "GCP" + }, + { + "id": 134, + "name": "europe-west8", + "provider": "GCP" + }, + { + "id": 113, "name": "europe-west6", "provider": "GCP" }, { + "id": 129, + "name": "me-west1", + "provider": "GCP" + }, + { + "id": 135, + "name": "europe-west9", + "provider": "GCP" + }, + { + "id": 77, "name": "northamerica-northeast1", "provider": "GCP" }, { - "name": "southamerica-east1", + "id": 136, + "name": "europe-west12", + "provider": "GCP" + }, + { + "id": 137, + "name": "europe-central2", + "provider": "GCP" + }, + { + "id": 131, + "name": "northamerica-northeast2", + "provider": "GCP" + }, + { + "id": 138, + "name": "me-central2", + "provider": "GCP" + }, + { + "id": 139, + "name": "me-central1", + "provider": "GCP" + }, + { + "id": 140, + "name": "us-east5", + "provider": "GCP" + }, + { + "id": 141, + "name": "us-south1", "provider": "GCP" }, { + "id": 27, "name": "us-central1", "provider": "GCP" }, { + "id": 38, "name": "us-east1", "provider": "GCP" }, { + "id": 39, "name": "us-east4", "provider": "GCP" }, { + "id": 40, "name": "us-west1", "provider": "GCP" }, { + "id": 82, "name": "us-west2", "provider": "GCP" + }, + { + "id": 142, + "name": "southamerica-west1", + "provider": "GCP" + }, + { + "id": 95, + "name": "southamerica-east1", + "provider": "GCP" + }, + { + "id": 143, + "name": "africa-south1", + "provider": "GCP" } ] } @@ -13542,6 +13962,7 @@ "cloudDetails": [ { "provider": "AWS", + "awsAccountId": "550680565604", "cloudAccountId": 1666, "totalSizeInGb": 0.0272, "regions": [ @@ -14700,6 +15121,17 @@ }, "description": "Database tag" }, + "BdbAvailableVersionsResponse": { + "type": "object", + "properties": { + "targets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TargetVersion" + } + } + } + }, "SubscriptionSpec": { "required": [ "regions" @@ -15377,6 +15809,10 @@ "Region": { "type": "object", "properties": { + "id": { + "type": "integer", + "format": "int32" + }, "name": { "type": "string" }, @@ -15476,7 +15912,6 @@ "SUBSCRIPTION_BAD_PREFERRED_AZ_SIZE", "SUBSCRIPTION_PREFERRED_AZ_INVALID_VALUE", "SUBSCRIPTION_PREFERRED_AZ_MUST_BE_DEFINED_ONCE", - "ACTIVE_ACTIVE_SUBSCRIPTION_PREFERRED_AZ_NOT_SUPPORTED", "SUBSCRIPTION_PREFERRED_AZ_IS_DISABLED", "SUBSCRIPTION_MUST_HAVE_AT_LEAST_ONE_DATABASE", "SUBSCRIPTION_REDIS_VERSION_INVALID_VALUE", @@ -15503,7 +15938,6 @@ "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_INVALID_REGION", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_DUPLICATE_REGIONS", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_INVALID_FORMAT", - "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_CREATE_FAILED", "ACTIVE_ACTIVE_CREATE_A_REGION_CUSTOMER_MANAGED_KEY_RESOURCE_NAME_SUBSCRIPTION_IS_NOT_CUSTOMER_MANAGED", "ACTIVE_ACTIVE_CREATE_A_REGION_CUSTOMER_MANAGED_KEY_RESOURCE_NAME_IS_NOT_SET", "PLANNED_SUBSCRIPTION_INVALID_PLAN_ID", @@ -16005,8 +16439,11 @@ "PRIVATE_LINK_DELETING_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRINCIPALS_IS_NOT_ALLOWED_WITH_A_SINGLE_REGION_SUBSCRIPTION", "PRIVATE_LINK_CREATE_A_FLEXIBLE_SUBSCRIPTION_PRIVATE_LINK_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION", "PRIVATE_LINK_CREATE_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_LINK_IS_NOT_ALLOWED_WITH_A_SINGLE_REGION_SUBSCRIPTION", + "PRIVATE_LINK_DELETING_A_FLEXIBLE_SUBSCRIPTION_PRIVATE_LINK_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION", + "PRIVATE_LINK_DELETING_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_LINK_IS_NOT_ALLOWED_WITH_A_SINGLE_REGION_SUBSCRIPTION", "PRIVATE_LINK_IS_NOT_SUPPORTED", - "PRIVATE_LINK_SERVICE_ERROR" + "PRIVATE_LINK_SERVICE_ERROR", + "COST_REPORT_IS_NOT_SUPPORTED" ] }, "additionalInfo": { @@ -16443,7 +16880,7 @@ }, "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'", + "description": "Optional. Persistent storage encryption secures data at rest for database persistence. By default, disk storage is encrypted by keys managed by the cloud provider. Use 'customer-managed-key' if you want to use self-managed persistent storage encryption keys. Default: 'cloud-provider-managed-key'", "example": "cloud-provider-managed-key", "enum": [ "cloud-provider-managed-key", @@ -17011,12 +17448,12 @@ "properties": { "resourceName": { "type": "string", - "description": "Required. Resource name of the customer managed key as defined by the cloud provider.", + "description": "The resource name of the customer managed key.", "example": "projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME" }, "region": { "type": "string", - "description": "Name of region to for the customer managed key as defined by the cloud provider. Required for active-active subscriptions." + "description": "(Required for Active-Active subscriptions only) Region for the customer managed key as defined by the cloud provider." } }, "description": "Object representing a customer managed key (CMK), along with the region it is associated to." @@ -17082,7 +17519,7 @@ }, "customerManagedKeyResourceName": { "type": "string", - "description": "Optional. Resource name of the customer managed key as defined by the cloud provider for customer managed subscriptions.", + "description": "Required for subscriptions where 'persistentStorageEncryptionType' is 'customer-managed-key'. The resource name of the customer-managed encryption key for the region.", "example": "projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME" }, "commandType": { From 0e63ada9c81f3297406f46c785e54b86af78d17c Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Wed, 5 Nov 2025 01:58:53 +0000 Subject: [PATCH 17/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 24 +++++++------------ 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 8b03093ae1..a2565ab4ff 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -11200,10 +11200,6 @@ "type": "boolean", "description": "Optional. Databases replication. Default: 'true'" }, - "autoMinorVersionUpgrade": { - "type": "boolean", - "description": "Optional. When 'true', enables auto minor version upgrades for this database. Default: 'true'" - }, "throughputMeasurement": { "$ref": "#/components/schemas/DatabaseThroughputSpec" }, @@ -11669,10 +11665,6 @@ "type": "boolean", "description": "Optional. Turns database replication on or off." }, - "autoMinorVersionUpgrade": { - "type": "boolean", - "description": "Optional. When 'true', enables auto minor version upgrades for this database." - }, "regexRules": { "type": "array", "description": "Optional. Hashing policy Regex rules. Used only if 'shardingType' is 'custom-regex-rules'.", @@ -15484,10 +15476,6 @@ "noeviction" ] }, - "autoMinorVersionUpgrade": { - "type": "boolean", - "description": "Optional. When 'true', enables auto minor version upgrades for this database." - }, "commandType": { "type": "string", "readOnly": true @@ -15695,10 +15683,6 @@ "type": "boolean", "description": "Optional. Sets database replication. Default: 'true'" }, - "autoMinorVersionUpgrade": { - "type": "boolean", - "description": "Optional. When 'true', enables auto minor version upgrades for this database. Default: 'true'" - }, "replicaOf": { "type": "array", "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'. If the URI provided is a Redis Cloud database, only host and port should be provided. Example: ['redis://endpoint1:6379', 'redis://endpoint2:6380'].", @@ -17495,6 +17479,14 @@ "description": "Optional. Enter a security group identifier that exists in the hosted AWS account. Security group Identifier must be in a valid format (for example: 'sg-0125be68a4625884ad') and must exist within the hosting account.", "example": "sg-0125be68a4625884ad" }, + "preferredAvailabilityZones": { + "type": "array", + "description": "Optional. List the zone IDs for your preferred availability zones for the cloud provider and region.", + "items": { + "type": "string", + "description": "Optional. List the zone IDs for your preferred availability zones for the cloud provider and region." + } + }, "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, and does not create any resources. Default: 'false'", From eafd1305a01cac88c326bbaf482bb12fd732f648 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Mon, 17 Nov 2025 02:00:37 +0000 Subject: [PATCH 18/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 319 ++++++++++++++++-- 1 file changed, 292 insertions(+), 27 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index a2565ab4ff..3adf9f868a 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -2862,7 +2862,7 @@ "Subscriptions - Pro" ], "summary": "Get Pro subscription CIDR whitelist", - "description": "(Self-hosted AWS subscriptions only) Gets a Pro subscription's CIDR whitelist.", + "description": "(Bring your own Cloud only) Gets a Pro subscription's CIDR whitelist. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getCidrWhiteList", "parameters": [ { @@ -2918,7 +2918,7 @@ "Subscriptions - Pro" ], "summary": "Update Pro subscription CIDR whitelist", - "description": "(Self-hosted AWS subscriptions only) Updates a Pro subscription's CIDR whitelist.", + "description": "(Bring your own Cloud only) Updates a Pro subscription's CIDR whitelist.", "operationId": "updateSubscriptionCidrWhiteList", "parameters": [ { @@ -4929,7 +4929,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Private Service Connect for a single region", - "description": "(Active-Active subscriptions only) Gets Private Service Connect details for a single region in an Active-Active subscription.", + "description": "(Active-Active subscriptions only) Gets Private Service Connect details for a single region in an Active-Active subscription. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getActiveActivePscService", "parameters": [ { @@ -5144,7 +5144,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Private Service Connect endpoints for a single region", - "description": "(Active-Active subscriptions only) Gets endpoint details for the specified Private Service Connect in a single region in an Active-Active subscription.", + "description": "(Active-Active subscriptions only) Gets endpoint details for the specified Private Service Connect in a single region in an Active-Active subscription. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getActiveActivePscServiceEndpoints", "parameters": [ { @@ -5317,7 +5317,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Private Link configuration for a specific region", - "description": "(Active-Active subscriptions only) Gets the Private Link configuration for a specific region.", + "description": "(Active-Active subscriptions only) Gets the Private Link configuration for a specific region. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getActiveActivePrivateLink", "parameters": [ { @@ -5716,7 +5716,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Active-Active VPC peering details", - "description": "(Active-Active subscriptions only) Gets VPC peering details for an Active-Active subscription.", + "description": "(Active-Active subscriptions only) Gets VPC peering details for an Active-Active subscription. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getActiveActiveVpcPeerings", "parameters": [ { @@ -5859,7 +5859,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Private Service Connect", - "description": "Gets Private Service Connect details for a subscription.", + "description": "Gets Private Service Connect details for a subscription. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getPscService", "parameters": [ { @@ -6044,7 +6044,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Private Service Connect endpoints", - "description": "Gets endpoint details for the specified Private Service Connect.", + "description": "Gets endpoint details for the specified Private Service Connect. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getPscServiceEndpoints", "parameters": [ { @@ -6197,7 +6197,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Private Link configuration", - "description": "Gets the Private Link configuration for a subscription.", + "description": "Gets the Private Link configuration for a subscription. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getPrivateLink", "parameters": [ { @@ -6541,7 +6541,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get VPC peering details", - "description": "Gets VPC peering details for the specified subscription.", + "description": "Gets VPC peering details for the specified subscription. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getVpcPeering", "parameters": [ { @@ -8038,6 +8038,71 @@ } } }, + "/cost-report": { + "post": { + "tags": [ + "Account" + ], + "summary": "Generate cost report (Beta)", + "description": "Generates a cost report in FOCUS format for the specified time period (max 40 days range) and filters. [Read more about focus here](https://focus.finops.org/).\n", + "operationId": "createCostReport", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CostReportCreateRequest" + } + } + }, + "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" + }, + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaskStateUpdate" + } + } + } + }, + "401": { + "description": "Unauthorized - Authentication failed for requested resource" + }, + "403": { + "description": "Forbidden - Not allowed to create requested resource (primarily due to not active resource)" + }, + "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 the new name" + }, + "422": { + "description": "Unprocessable Entity - The server understands the request, and the syntax of the request is correct, but it was unable to process the contained instructions" + }, + "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 " + } + } + } + }, "/cloud-accounts": { "get": { "tags": [ @@ -8629,7 +8694,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get transit gateways for a subscription", - "description": "Gets all AWS transit gateway details for the specified subscription.", + "description": "Gets all AWS transit gateway details for the specified subscription. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getTgws", "parameters": [ { @@ -8687,7 +8752,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get transit gateway invitations for a subscription", - "description": "Gets all AWS transit gateway invitations for the specified subscription.", + "description": "Gets all AWS transit gateway invitations for the specified subscription. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getTgwSharedInvitations", "parameters": [ { @@ -8745,7 +8810,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get transit gateways for a single region", - "description": "(Active-Active subscriptions only) Gets all AWS transit gateway details for the specified region in an Active-Active subscription.", + "description": "(Active-Active subscriptions only) Gets all AWS transit gateway details for the specified region in an Active-Active subscription. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getActiveActiveTgws", "parameters": [ { @@ -8814,7 +8879,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get transit gateway invitations for a single region", - "description": "(Active-Active subscriptions only) Gets AWS transit gateway invitations for the specified region in an Active-Active subscription.", + "description": "(Active-Active subscriptions only) Gets AWS transit gateway invitations for the specified region in an Active-Active subscription. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getActiveActiveTgwSharedInvitations", "parameters": [ { @@ -8883,7 +8948,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Private Service Connect endpoint deletion script for a single region", - "description": "(Active-Active subscriptions only) Gets the gcloud script to delete the specified Private Service Connect endpoint on Google Cloud.", + "description": "(Active-Active subscriptions only) Gets the gcloud script to delete the specified Private Service Connect endpoint on Google Cloud. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getActiveActivPscServiceEndpointDeletionScript", "parameters": [ { @@ -8971,7 +9036,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Private Service Connect endpoint creation script for a single region", - "description": "(Active-Active subscriptions only) Gets the gcloud script to create the specified Private Service Connect endpoint on Google Cloud.", + "description": "(Active-Active subscriptions only) Gets the gcloud script to create the specified Private Service Connect endpoint on Google Cloud. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getActiveActivPscServiceEndpointCreationScript", "parameters": [ { @@ -9059,7 +9124,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Private Link endpoint script for a single region", - "description": "(Active-Active subscriptions only) Gets the Private Link endpoint script for a single region in an Active-Active subscription.", + "description": "(Active-Active subscriptions only) Gets the Private Link endpoint script for a single region in an Active-Active subscription. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getActiveActivePrivateLinkEndpointScript", "parameters": [ { @@ -9127,7 +9192,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Private Service Connect endpoint deletion script", - "description": "Gets the gcloud script to delete the specified Private Service Connect endpoint on Google Cloud.", + "description": "Gets the gcloud script to delete the specified Private Service Connect endpoint on Google Cloud. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getPscServiceEndpointDeletionScript", "parameters": [ { @@ -9205,7 +9270,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Private Service Connect endpoint creation script", - "description": "Gets the gcloud script to create the specified Private Service Connect endpoint on Google Cloud.", + "description": "Gets the gcloud script to create the specified Private Service Connect endpoint on Google Cloud. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getPscServiceEndpointCreationScript", "parameters": [ { @@ -9283,7 +9348,7 @@ "Subscriptions - Pro - Connectivity" ], "summary": "Get Private Link endpoint script", - "description": "Gets the Python discovery script for Private Link. Internal users can optionally request a Terraform snippet.", + "description": "Gets the Python discovery script for Private Link. Internal users can optionally request a Terraform snippet. [Asynchronous operation](https://redis.io/docs/latest/operate/rc/api/get-started/process-lifecycle/) - Query [GET /tasks/{taskId}](#tag/Tasks/operation/getTaskById) with the returned taskId.", "operationId": "getPrivateLinkEndpointScript", "parameters": [ { @@ -9764,7 +9829,7 @@ "Account" ], "summary": "Get available Pro plan regions", - "description": "Gets a list of available regions for Pro subscriptions. For Essentials subscriptions, use 'GET /fixed/plans'.", + "description": "Gets a list of available regions for Pro subscriptions. For Essentials subscriptions, use [GET /fixed/plans](#tag/Subscriptions-Essentials/operation/getAllFixedSubscriptionsPlans).", "operationId": "getSupportedRegions", "parameters": [ { @@ -10401,7 +10466,7 @@ "Account" ], "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.", + "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 databases prior to Redis 8. Advanced capability support may differ based on subscription and database settings.", "operationId": "getSupportedDatabaseModules", "responses": { "400": { @@ -10487,6 +10552,60 @@ } } }, + "/cost-report/{costReportId}": { + "get": { + "tags": [ + "Account" + ], + "summary": "Get cost report (Beta)", + "description": "Returns the generated cost report file in FOCUS format using the costReportId returned from the cost report generation task. The file is downloaded as an attachment with the filename set to the costReportId.", + "operationId": "getCostReport", + "parameters": [ + { + "name": "costReportId", + "in": "path", + "description": "Cost Report ID. Returned from a Cost Report generation task.", + "required": true, + "schema": { + "type": "string" + }, + "example": "cost-report-12345-abcdef" + } + ], + "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": "Returns the cost report file", + "content": { + "application/octet-stream": {} + } + }, + "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 " + } + } + } + }, "/": { "get": { "tags": [ @@ -11212,7 +11331,7 @@ }, "modules": { "type": "array", - "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.", + "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. Don't specify modules for database versions 8 and above. All capabilities are bundled in the database by default.", "items": { "$ref": "#/components/schemas/DatabaseModuleSpec" } @@ -11571,7 +11690,7 @@ }, "modules": { "type": "array", - "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'.", + "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'. Don't specify modules for database versions 8 and above. All capabilities are bundled in the database by default.", "items": { "$ref": "#/components/schemas/DatabaseModuleSpec" } @@ -12907,6 +13026,97 @@ }, "description": "Subscription update request message" }, + "CostReportCreateRequest": { + "required": [ + "endDate", + "startDate" + ], + "type": "object", + "properties": { + "startDate": { + "type": "string", + "description": "Filter for usage starting on or after this date. Must be in format YYYY-MM-DD", + "format": "YYYY-MM-DD", + "example": "2025-10-01" + }, + "endDate": { + "type": "string", + "description": "Filter for usage ending on or before this date. Must be in format YYYY-MM-DD and must be after start date", + "format": "YYYY-MM-DD", + "example": "2025-11-06" + }, + "format": { + "type": "string", + "description": "Output format for the cost report", + "example": "csv", + "default": "csv", + "enum": [ + "json", + "csv" + ] + }, + "subscriptionIds": { + "type": "array", + "description": "Array of subscriptionIDs to filter by", + "example": [ + 123, + 456 + ], + "items": { + "type": "integer", + "description": "Array of subscriptionIDs to filter by", + "format": "int32" + } + }, + "databaseIds": { + "type": "array", + "description": "Array of database IDs to filter by", + "example": [ + 789, + 101112 + ], + "items": { + "type": "integer", + "description": "Array of database IDs to filter by", + "format": "int32" + } + }, + "subscriptionType": { + "type": "string", + "description": "Filter by plan type", + "example": "pro", + "enum": [ + "pro", + "essentials" + ] + }, + "regions": { + "type": "array", + "description": "Array of regions to filter by", + "example": [ + "us-east-1", + "eu-west-1" + ], + "items": { + "type": "string", + "description": "Array of regions to filter by", + "example": "[\"us-east-1\",\"eu-west-1\"]" + } + }, + "tags": { + "type": "array", + "description": "Array of key-value pairs for tag filtering", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "commandType": { + "type": "string", + "readOnly": true + } + }, + "description": "Cost report generation request" + }, "AccountSubscriptionDatabases": { "type": "object", "properties": { @@ -13787,6 +13997,18 @@ } } }, + "ResourceTag": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "description": "Optional. A list of resource tags to apply to the subscription. (max. 30 tags)." + }, "CustomerManagedKeyAccessDetails": { "type": "object", "properties": { @@ -13908,6 +14130,26 @@ } } }, + "Tag": { + "required": [ + "key", + "value" + ], + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Tag key", + "example": "environment" + }, + "value": { + "type": "string", + "description": "Tag value", + "example": "production" + } + }, + "description": "Tag filter for cost report" + }, "AccountSubscriptions": { "type": "object", "properties": { @@ -15151,6 +15393,13 @@ "items": { "$ref": "#/components/schemas/SubscriptionRegionSpec" } + }, + "resourceTags": { + "type": "array", + "description": "Optional. A list of resource tags to apply to the subscription. (max. 30 tags).", + "items": { + "$ref": "#/components/schemas/ResourceTag" + } } }, "description": "Cloud provider, region, and networking details." @@ -15201,7 +15450,7 @@ "example": {} } }, - "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." + "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. Don't specify modules for database versions 8 and above. All capabilities are bundled in the database by default." }, "FixedSubscriptionCreateRequest": { "required": [ @@ -15764,7 +16013,7 @@ }, "modules": { "type": "array", - "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.", + "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. Don't specify modules for database versions 8 and above. All capabilities are bundled in the database by default.", "items": { "$ref": "#/components/schemas/DatabaseModuleSpec" } @@ -15904,6 +16153,15 @@ "SUBSCRIPTION_GCP_ALLOW_ONLY_INTERNAL", "CLUSTER_UNDER_MAINTENANCE", "ACTIVE_ACTIVE_SUBSCRIPTION_IS_NOT_SUPPORTED", + "RESOURCE_TAGS_EXCEEDS_MAXIMUM_COUNT", + "RESOURCE_TAG_KEY_EXCEEDS_MAXIMUM_LENGTH", + "RESOURCE_TAG_VALUE_EXCEEDS_MAXIMUM_LENGTH", + "RESOURCE_TAGS_NOT_ALLOWED_WITH_INTERNAL_CLOUD_ACCOUNT", + "RESOURCE_TAGS_NOT_ALLOWED", + "RESOURCE_TAGS_NAME_NOT_ALLOWED", + "RESOURCE_TAGS_EMPTY_KEY", + "RESOURCE_TAGS_DUPLICATE_KEY", + "RESOURCE_TAGS_MISSING_VALUE", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_IS_NOT_SUPPORTED", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_MISSING_USAGE_PERMISSIONS", "CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_MISSING_GET_KEY_PERMISSIONS", @@ -16427,7 +16685,14 @@ "PRIVATE_LINK_DELETING_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_LINK_IS_NOT_ALLOWED_WITH_A_SINGLE_REGION_SUBSCRIPTION", "PRIVATE_LINK_IS_NOT_SUPPORTED", "PRIVATE_LINK_SERVICE_ERROR", - "COST_REPORT_IS_NOT_SUPPORTED" + "COST_REPORT_IS_NOT_SUPPORTED", + "COST_REPORT_START_DATE_IS_MISSING", + "COST_REPORT_END_DATE_IS_MISSING", + "COST_REPORT_INVALID_DATE_FORMAT", + "COST_REPORT_END_DATE_BEFORE_START_DATE", + "COST_REPORT_DATE_RANGE_EXCEEDS_LIMIT", + "COST_REPORT_TAG_KEY_EMPTY", + "COST_REPORT_TAG_VALUE_EMPTY" ] }, "additionalInfo": { From f1921ef4c92f88546e90313d88f1c29c997573a0 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Fri, 21 Nov 2025 01:57:57 +0000 Subject: [PATCH 19/20] Update content/operate/rc/api/api-reference/openapi.json --- .../operate/rc/api/api-reference/openapi.json | 34 ++++++++++++++++--- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 3adf9f868a..7cf72a2d0d 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -11344,8 +11344,15 @@ }, "averageItemSizeInBytes": { "type": "integer", - "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" + "description": "Optional. Relevant only to ram-and-flash (also known as Redis-Flex/Auto-Tiering) subscriptions. Estimated average size in bytes of the items stored in the database. Default: 1000", + "format": "int64", + "deprecated": true + }, + "ramPercentage": { + "type": "integer", + "description": "Optional. Relevant only to ram-and-flash (also known as Redis-Flex/Auto-Tiering) subscriptions. The percentage of data to be stored in RAM. Range: 10-50. Default: 20", + "format": "int32", + "example": 20 }, "respVersion": { "type": "string", @@ -11873,6 +11880,12 @@ "$ref": "#/components/schemas/DatabaseAlertSpec" } }, + "ramPercentage": { + "type": "integer", + "description": "Optional. Relevant only to ram-and-flash (also known as Redis-Flex/Auto-Tiering) subscriptions. The percentage of data to be stored in RAM. Range: 10-50.", + "format": "int32", + "example": 20 + }, "commandType": { "type": "string", "readOnly": true @@ -15956,8 +15969,15 @@ }, "averageItemSizeInBytes": { "type": "integer", - "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" + "description": "Optional. Relevant only to ram-and-flash (also known as Redis-Flex/Auto-Tiering) subscriptions. Estimated average size in bytes of the items stored in the database. Default: 1000", + "format": "int64", + "deprecated": true + }, + "ramPercentage": { + "type": "integer", + "description": "Optional. Relevant only to ram-and-flash (also known as Redis-Flex/Auto-Tiering) subscriptions. The percentage of data to be stored in RAM. Range: 10-50. Default: 20", + "format": "int32", + "example": 20 }, "periodicBackupPath": { "type": "string", @@ -16252,6 +16272,12 @@ "DATABASE_MEMCACHED_SASL_PASSWORD_MAX_LENGTH", "DATABASE_REDIS_FLEX_CONTAINS_MODULES", "DATABASE_AVERAGE_ITEM_SIZE_NOT_ALLOWED", + "DATABASE_RAM_PERCENTAGE_NOT_ALLOWED", + "DATABASE_RAM_PERCENTAGE_NOT_SUPPORTED", + "DATABASE_RAM_PERCENTAGE_IS_INVALID", + "DATABASE_AVERAGE_ITEM_SIZE_IS_DEPRECATED", + "DATABASE_MEMORY_LIMIT_IS_INVALID_FOR_ROF", + "DATABASE_DATASET_SIZE_IS_INVALID_FOR_ROF", "DATABASE_SIZE_SMALLER_THAN_USAGE", "DATABASE_USAGE_EXCEEDS_GLOBAL_LIMIT", "DATABASE_USAGE_EXCEEDS_LOCAL_LIMIT", From f6a2458e676b3eb86fed15a19d3c49146852a64a Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Thu, 27 Nov 2025 01:58:02 +0000 Subject: [PATCH 20/20] Update content/operate/rc/api/api-reference/openapi.json --- content/operate/rc/api/api-reference/openapi.json | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/content/operate/rc/api/api-reference/openapi.json b/content/operate/rc/api/api-reference/openapi.json index 7cf72a2d0d..7b2c117f06 100644 --- a/content/operate/rc/api/api-reference/openapi.json +++ b/content/operate/rc/api/api-reference/openapi.json @@ -11350,7 +11350,7 @@ }, "ramPercentage": { "type": "integer", - "description": "Optional. Relevant only to ram-and-flash (also known as Redis-Flex/Auto-Tiering) subscriptions. The percentage of data to be stored in RAM. Range: 10-50. Default: 20", + "description": "Optional. Relevant only to ram-and-flash (also known as Redis-Flex/Auto-Tiering) subscriptions. The percentage of data to be stored in RAM. Must be between 10 and 50 in steps of 10 (10, 20, 30, 40, 50). Default: 20", "format": "int32", "example": 20 }, @@ -11882,7 +11882,7 @@ }, "ramPercentage": { "type": "integer", - "description": "Optional. Relevant only to ram-and-flash (also known as Redis-Flex/Auto-Tiering) subscriptions. The percentage of data to be stored in RAM. Range: 10-50.", + "description": "Optional. Relevant only to ram-and-flash (also known as Redis-Flex/Auto-Tiering) subscriptions. The percentage of data to be stored in RAM. Must be between 10 and 50 in steps of 10 (10, 20, 30, 40, 50).", "format": "int32", "example": 20 }, @@ -15975,7 +15975,7 @@ }, "ramPercentage": { "type": "integer", - "description": "Optional. Relevant only to ram-and-flash (also known as Redis-Flex/Auto-Tiering) subscriptions. The percentage of data to be stored in RAM. Range: 10-50. Default: 20", + "description": "Optional. Relevant only to ram-and-flash (also known as Redis-Flex/Auto-Tiering) subscriptions. The percentage of data to be stored in RAM. Must be between 10 and 50 in steps of 10 (10, 20, 30, 40, 50). Default: 20", "format": "int32", "example": 20 }, @@ -16348,6 +16348,7 @@ "DATABASE_REDIS_VERSION_IS_NOT_SUPPORTED_FOR_MEMCACHED", "DATABASE_REDIS_VERSION_IS_REQUIRED", "DATABASE_REDIS_VERSION_INVALID_VALUE", + "INCOMPATIBLE_TF_PROVIDER", "CONNECTIVITY_REQUESTS_ON_CUSTOMER_MANAGED_VPC_SUBSCRIPTION", "VPC_PEERING_NOT_ACTIVE", "VPC_PEERING_GENERAL_ERROR",