Skip to content

Commit 8cdaf05

Browse files
redisdocsapp[bot]redisdocsapp[bot]
committed
Update content/operate/rc/api/api-reference/openapi.json
1 parent 1384274 commit 8cdaf05

File tree

1 file changed

+188
-5
lines changed

1 file changed

+188
-5
lines changed

‎content/operate/rc/api/api-reference/openapi.json

Lines changed: 188 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@
350350
"content": {
351351
"application/json": {
352352
"schema": {
353-
"$ref": "#/components/schemas/SubscriptionUpdateRequest"
353+
"$ref": "#/components/schemas/BaseSubscriptionUpdateRequest"
354354
}
355355
}
356356
},
@@ -4633,7 +4633,6 @@
46334633
"paymentMethod": "credit-card",
46344634
"paymentMethodId": 12345,
46354635
"memoryStorage": "ram",
4636-
"persistentStorageEncryption": true,
46374636
"cloudProviders": [
46384637
{
46394638
"provider": "AWS",
@@ -8528,6 +8527,18 @@
85288527
"summary": "Get available Redis database versions",
85298528
"description": "Gets a list of all available Redis database versions for Pro subscriptions.",
85308529
"operationId": "getRedisVersions",
8530+
"parameters": [
8531+
{
8532+
"name": "subscriptionId",
8533+
"in": "query",
8534+
"description": "Subscription ID (required for an existing subscription)",
8535+
"required": false,
8536+
"schema": {
8537+
"type": "integer",
8538+
"format": "int32"
8539+
}
8540+
}
8541+
],
85318542
"responses": {
85328543
"400": {
85338544
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
@@ -8931,6 +8942,64 @@
89318942
}
89328943
}
89338944
},
8945+
"/fixed/redis-versions": {
8946+
"get": {
8947+
"tags": [
8948+
"Subscriptions - Essentials"
8949+
],
8950+
"summary": "Get available Redis database versions for specific Essentials subscription",
8951+
"description": "Gets a list of all available Redis database versions for a specific Essentials subscription.",
8952+
"operationId": "getRedisVersions_1",
8953+
"parameters": [
8954+
{
8955+
"name": "subscriptionId",
8956+
"in": "query",
8957+
"description": "Subscription ID.",
8958+
"required": true,
8959+
"schema": {
8960+
"type": "integer",
8961+
"format": "int32"
8962+
}
8963+
}
8964+
],
8965+
"responses": {
8966+
"400": {
8967+
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
8968+
},
8969+
"412": {
8970+
"description": "Precondition Failed - Feature flag for this flow is off"
8971+
},
8972+
"200": {
8973+
"description": "OK",
8974+
"content": {
8975+
"application/json": {
8976+
"schema": {
8977+
"$ref": "#/components/schemas/RedisVersions"
8978+
}
8979+
}
8980+
}
8981+
},
8982+
"401": {
8983+
"description": "Unauthorized - Authentication failed for requested resource"
8984+
},
8985+
"403": {
8986+
"description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"
8987+
},
8988+
"404": {
8989+
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
8990+
},
8991+
"429": {
8992+
"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)"
8993+
},
8994+
"500": {
8995+
"description": "Internal system error - If this error persists, please contact customer support"
8996+
},
8997+
"503": {
8998+
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
8999+
}
9000+
}
9001+
}
9002+
},
89349003
"/fixed/plans": {
89359004
"get": {
89369005
"tags": [
@@ -9564,7 +9633,7 @@
95649633
"readOnly": true
95659634
}
95669635
},
9567-
"description": "Subscription update request"
9636+
"description": "Subscription update request message"
95689637
},
95699638
"DatabaseTagUpdateRequest": {
95709639
"required": [
@@ -10542,6 +10611,29 @@
1054210611
}
1054310612
]
1054410613
},
10614+
"BaseSubscriptionUpdateRequest": {
10615+
"type": "object",
10616+
"properties": {
10617+
"subscriptionId": {
10618+
"type": "integer",
10619+
"format": "int32",
10620+
"readOnly": true
10621+
},
10622+
"commandType": {
10623+
"type": "string",
10624+
"readOnly": true
10625+
}
10626+
},
10627+
"description": "Subscription update request message",
10628+
"oneOf": [
10629+
{
10630+
"$ref": "#/components/schemas/SubscriptionUpdateRequest"
10631+
},
10632+
{
10633+
"$ref": "#/components/schemas/SubscriptionUpdateCMKRequest"
10634+
}
10635+
]
10636+
},
1054510637
"Regions": {
1054610638
"type": "object",
1054710639
"properties": {
@@ -11239,6 +11331,40 @@
1123911331
}
1124011332
}
1124111333
},
11334+
"SubscriptionUpdateCMKRequest": {
11335+
"required": [
11336+
"customerManagedKeys"
11337+
],
11338+
"type": "object",
11339+
"properties": {
11340+
"subscriptionId": {
11341+
"type": "integer",
11342+
"format": "int32",
11343+
"readOnly": true
11344+
},
11345+
"commandType": {
11346+
"type": "string",
11347+
"readOnly": true
11348+
},
11349+
"deletionGracePeriod": {
11350+
"type": "string",
11351+
"description": "Optional. The grace period for deleting the subscription. If not set, will default to immediate deletion grace period.",
11352+
"example": "alerts-only",
11353+
"enum": [
11354+
"alerts-only",
11355+
"immediate"
11356+
]
11357+
},
11358+
"customerManagedKeys": {
11359+
"type": "array",
11360+
"description": "The customer managed keys (CMK) to use for this subscription. If is active-active subscription, must set a key for each region.",
11361+
"items": {
11362+
"$ref": "#/components/schemas/CustomerManagedKey"
11363+
}
11364+
}
11365+
},
11366+
"description": "Subscription update request message"
11367+
},
1124211368
"AccountSubscriptionDatabases": {
1124311369
"type": "object",
1124411370
"properties": {
@@ -14154,7 +14280,24 @@
1415414280
"ACTIVE_ACTIVE_SUBSCRIPTION_PREVIEW_REDIS_VERSION_IS_NOT_SUPPORTED",
1415514281
"SUBSCRIPTION_GCP_ALLOW_ONLY_INTERNAL",
1415614282
"CLUSTER_UNDER_MAINTENANCE",
14157-
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_TYPE_IS_NOT_SUPPORTED",
14283+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_IS_NOT_SUPPORTED",
14284+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_MISSING_USAGE_PERMISSIONS",
14285+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_MISSING_GET_KEY_PERMISSIONS",
14286+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_MISSING_GET_IAM_POLICY_PERMISSIONS",
14287+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_DISABLED_KEY",
14288+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_INVALID_KEY_NAME",
14289+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_WRONG_REGION",
14290+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_NOT_PENDING",
14291+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_INVALID_NUMBER_OF_KEYS",
14292+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_REGION_NOT_REQUIRED",
14293+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_REGION_REQUIRED",
14294+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_MISSING_KEYS",
14295+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_INVALID_REGION",
14296+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_DUPLICATE_REGIONS",
14297+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_INVALID_FORMAT",
14298+
"CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_CREATE_FAILED",
14299+
"ACTIVE_ACTIVE_CREATE_A_REGION_CUSTOMER_MANAGED_KEY_RESOURCE_NAME_SUBSCRIPTION_IS_NOT_CUSTOMER_MANAGED",
14300+
"ACTIVE_ACTIVE_CREATE_A_REGION_CUSTOMER_MANAGED_KEY_RESOURCE_NAME_IS_NOT_SET",
1415814301
"PLANNED_SUBSCRIPTION_INVALID_PLAN_ID",
1415914302
"PLANNER_TIMEOUT",
1416014303
"PLANNER_FAILURE",
@@ -14620,7 +14763,10 @@
1462014763
"DATABASE_REPLICA_OF_INCOMPATIBLE_VERSION",
1462114764
"DATABASE_UPGRADE_FAILED",
1462214765
"DATABASE_INVALID_PLAN_TYPE",
14623-
"DATABASE_UPGRADE_IS_NOT_SUPPORTED"
14766+
"DATABASE_UPGRADE_IS_NOT_SUPPORTED",
14767+
"ACTIVE_ACTIVE_EXTERNAL_ACCOUNTS_NOT_SUPPORTED",
14768+
"ACTIVE_ACTIVE_MULTIPLE_CLOUD_ACCOUNTS_NOT_SUPPORTED",
14769+
"ACTIVE_ACTIVE_GCP_EXTERNAL_CLOUD_ACCOUNT_NOT_SUPPORTED"
1462414770
]
1462514771
},
1462614772
"additionalInfo": {
@@ -14903,6 +15049,17 @@
1490315049
},
1490415050
"description": "Optional. Changes Remote backup configuration details."
1490515051
},
15052+
"DynamicEndpoints": {
15053+
"type": "object",
15054+
"properties": {
15055+
"public": {
15056+
"type": "string"
15057+
},
15058+
"private": {
15059+
"type": "string"
15060+
}
15061+
}
15062+
},
1490615063
"CrdbFlushRequest": {
1490715064
"type": "object",
1490815065
"properties": {
@@ -15348,6 +15505,9 @@
1534815505
"privateEndpoint": {
1534915506
"type": "string"
1535015507
},
15508+
"dynamicEndpoints": {
15509+
"$ref": "#/components/schemas/DynamicEndpoints"
15510+
},
1535115511
"links": {
1535215512
"type": "array",
1535315513
"items": {
@@ -15514,6 +15674,24 @@
1551415674
},
1551515675
"description": "Upgrades the specified Pro database to a later Redis version."
1551615676
},
15677+
"CustomerManagedKey": {
15678+
"required": [
15679+
"resourceName"
15680+
],
15681+
"type": "object",
15682+
"properties": {
15683+
"resourceName": {
15684+
"type": "string",
15685+
"description": "Required. Resource name of the customer managed key as defined by the cloud provider.",
15686+
"example": "projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"
15687+
},
15688+
"region": {
15689+
"type": "string",
15690+
"description": "Name of region to for the customer managed key as defined by the cloud provider. Required for active-active subscriptions."
15691+
}
15692+
},
15693+
"description": "Object representing a customer managed key (CMK), along with the region it is associated to."
15694+
},
1551715695
"ActiveActiveRegionCreateRequest": {
1551815696
"required": [
1551915697
"deploymentCIDR"
@@ -15556,6 +15734,11 @@
1555615734
"resp3"
1555715735
]
1555815736
},
15737+
"customerManagedKeyResourceName": {
15738+
"type": "string",
15739+
"description": "Optional. Resource name of the customer managed key as defined by the cloud provider for customer managed subscriptions.",
15740+
"example": "projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"
15741+
},
1555915742
"commandType": {
1556015743
"type": "string",
1556115744
"readOnly": true

0 commit comments

Comments
 (0)