Skip to content

Commit 0a8587b

Browse files
redisdocsapp[bot]redisdocsapp[bot]
committed
Update content/operate/rc/api/api-reference/openapi.json
1 parent e5defeb commit 0a8587b

File tree

1 file changed

+208
-0
lines changed

1 file changed

+208
-0
lines changed

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

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4633,6 +4633,7 @@
46334633
"deploymentType": "single-region",
46344634
"paymentMethod": "credit-card",
46354635
"paymentMethodId": 12345,
4636+
"publicEndpointAccess": true,
46364637
"memoryStorage": "ram",
46374638
"cloudProviders": [
46384639
{
@@ -7453,6 +7454,156 @@
74537454
}
74547455
}
74557456
},
7457+
"/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/upgrade": {
7458+
"get": {
7459+
"tags": [
7460+
"Databases - Essentials"
7461+
],
7462+
"summary": "Get Essentials database version upgrade status",
7463+
"description": "Gets information on the latest upgrade attempt for this Essentials database.",
7464+
"operationId": "getEssentialsDatabaseRedisVersionUpgradeStatus",
7465+
"parameters": [
7466+
{
7467+
"name": "subscriptionId",
7468+
"in": "path",
7469+
"description": "Subscription ID.",
7470+
"required": true,
7471+
"schema": {
7472+
"type": "integer",
7473+
"format": "int32"
7474+
}
7475+
},
7476+
{
7477+
"name": "databaseId",
7478+
"in": "path",
7479+
"description": "Database ID.",
7480+
"required": true,
7481+
"schema": {
7482+
"type": "integer",
7483+
"format": "int32"
7484+
}
7485+
}
7486+
],
7487+
"responses": {
7488+
"400": {
7489+
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
7490+
},
7491+
"412": {
7492+
"description": "Precondition Failed - Feature flag for this flow is off"
7493+
},
7494+
"200": {
7495+
"description": "OK",
7496+
"content": {
7497+
"application/json": {
7498+
"schema": {
7499+
"$ref": "#/components/schemas/BdbVersionUpgradeStatus"
7500+
}
7501+
}
7502+
}
7503+
},
7504+
"401": {
7505+
"description": "Unauthorized - Authentication failed for requested resource"
7506+
},
7507+
"403": {
7508+
"description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"
7509+
},
7510+
"404": {
7511+
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
7512+
},
7513+
"429": {
7514+
"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)"
7515+
},
7516+
"500": {
7517+
"description": "Internal system error - If this error persists, please contact customer support"
7518+
},
7519+
"503": {
7520+
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
7521+
}
7522+
}
7523+
},
7524+
"post": {
7525+
"tags": [
7526+
"Databases - Essentials"
7527+
],
7528+
"summary": "Upgrade Essentials database version",
7529+
"description": "Upgrades the specified Essentials database to a later Redis version.",
7530+
"operationId": "upgradeEssentialsDatabaseRedisVersion",
7531+
"parameters": [
7532+
{
7533+
"name": "subscriptionId",
7534+
"in": "path",
7535+
"description": "Subscription ID.",
7536+
"required": true,
7537+
"schema": {
7538+
"type": "integer",
7539+
"format": "int32"
7540+
}
7541+
},
7542+
{
7543+
"name": "databaseId",
7544+
"in": "path",
7545+
"description": "Database ID.",
7546+
"required": true,
7547+
"schema": {
7548+
"type": "integer",
7549+
"format": "int32"
7550+
}
7551+
}
7552+
],
7553+
"requestBody": {
7554+
"content": {
7555+
"application/json": {
7556+
"schema": {
7557+
"$ref": "#/components/schemas/FixedDatabaseUpgradeRedisVersionRequest"
7558+
}
7559+
}
7560+
},
7561+
"required": true
7562+
},
7563+
"responses": {
7564+
"400": {
7565+
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
7566+
},
7567+
"412": {
7568+
"description": "Precondition Failed - Feature flag for this flow is off"
7569+
},
7570+
"200": {
7571+
"description": "OK",
7572+
"content": {
7573+
"application/json": {
7574+
"schema": {
7575+
"$ref": "#/components/schemas/TaskStateUpdate"
7576+
}
7577+
}
7578+
}
7579+
},
7580+
"401": {
7581+
"description": "Unauthorized - Authentication failed for requested resource"
7582+
},
7583+
"403": {
7584+
"description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"
7585+
},
7586+
"404": {
7587+
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
7588+
},
7589+
"408": {
7590+
"description": "Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period"
7591+
},
7592+
"409": {
7593+
"description": "Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name)"
7594+
},
7595+
"429": {
7596+
"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)"
7597+
},
7598+
"500": {
7599+
"description": "Internal system error - If this error persists, please contact customer support"
7600+
},
7601+
"503": {
7602+
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
7603+
}
7604+
}
7605+
}
7606+
},
74567607
"/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/import": {
74577608
"get": {
74587609
"tags": [
@@ -10472,6 +10623,10 @@
1047210623
"marketplace"
1047310624
]
1047410625
},
10626+
"publicEndpointAccess": {
10627+
"type": "boolean",
10628+
"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."
10629+
},
1047510630
"commandType": {
1047610631
"type": "string",
1047710632
"readOnly": true
@@ -10766,6 +10921,10 @@
1076610921
"type": "boolean",
1076710922
"description": "Optional. Databases replication. Default: 'true'"
1076810923
},
10924+
"autoMinorVersionUpgrade": {
10925+
"type": "boolean",
10926+
"description": "Optional. When 'true', enables auto minor version upgrades for this database. Default: 'true'"
10927+
},
1076910928
"throughputMeasurement": {
1077010929
"$ref": "#/components/schemas/DatabaseThroughputSpec"
1077110930
},
@@ -10842,6 +11001,9 @@
1084211001
"status": {
1084311002
"type": "string"
1084411003
},
11004+
"publicEndpointAccess": {
11005+
"type": "boolean"
11006+
},
1084511007
"memoryStorage": {
1084611008
"type": "string",
1084711009
"enum": [
@@ -10886,6 +11048,7 @@
1088611048
"status": "active",
1088711049
"deploymentType": "single-region",
1088811050
"paymentMethodId": 2,
11051+
"publicEndpointAccess": true,
1088911052
"memoryStorage": "ram",
1089011053
"numberOfDatabases": 6,
1089111054
"paymentMethodType": "credit-card",
@@ -11227,6 +11390,10 @@
1122711390
"type": "boolean",
1122811391
"description": "Optional. Turns database replication on or off."
1122911392
},
11393+
"autoMinorVersionUpgrade": {
11394+
"type": "boolean",
11395+
"description": "Optional. When 'true', enables auto minor version upgrades for this database."
11396+
},
1123011397
"regexRules": {
1123111398
"type": "array",
1123211399
"description": "Optional. Hashing policy Regex rules. Used only if 'shardingType' is 'custom-regex-rules'.",
@@ -13356,6 +13523,7 @@
1335613523
"status": "active",
1335713524
"deploymentType": "single-region",
1335813525
"paymentMethodId": 123,
13526+
"publicEndpointAccess": true,
1335913527
"memoryStorage": "ram",
1336013528
"numberOfDatabases": 6,
1336113529
"paymentMethodType": "credit-card",
@@ -14735,6 +14903,34 @@
1473514903
]
1473614904
}
1473714905
},
14906+
"FixedDatabaseUpgradeRedisVersionRequest": {
14907+
"required": [
14908+
"targetRedisVersion"
14909+
],
14910+
"type": "object",
14911+
"properties": {
14912+
"databaseId": {
14913+
"type": "integer",
14914+
"format": "int32",
14915+
"readOnly": true
14916+
},
14917+
"subscriptionId": {
14918+
"type": "integer",
14919+
"format": "int32",
14920+
"readOnly": true
14921+
},
14922+
"targetRedisVersion": {
14923+
"type": "string",
14924+
"description": "The target Redis version the database will be upgraded to. Use GET /subscriptions/redis-versions to get a list of available Redis versions.",
14925+
"example": "7.4"
14926+
},
14927+
"commandType": {
14928+
"type": "string",
14929+
"readOnly": true
14930+
}
14931+
},
14932+
"description": "Upgrades the specified Essentials database to a later Redis version."
14933+
},
1473814934
"CrdbUpdatePropertiesRequest": {
1473914935
"type": "object",
1474014936
"properties": {
@@ -14856,6 +15052,10 @@
1485615052
"noeviction"
1485715053
]
1485815054
},
15055+
"autoMinorVersionUpgrade": {
15056+
"type": "boolean",
15057+
"description": "Optional. When 'true', enables auto minor version upgrades for this database."
15058+
},
1485915059
"commandType": {
1486015060
"type": "string",
1486115061
"readOnly": true
@@ -15063,6 +15263,10 @@
1506315263
"type": "boolean",
1506415264
"description": "Optional. Sets database replication. Default: 'true'"
1506515265
},
15266+
"autoMinorVersionUpgrade": {
15267+
"type": "boolean",
15268+
"description": "Optional. When 'true', enables auto minor version upgrades for this database. Default: 'true'"
15269+
},
1506615270
"replicaOf": {
1506715271
"type": "array",
1506815272
"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 @@
1626916473
"example": "7.2",
1627016474
"deprecated": true
1627116475
},
16476+
"publicEndpointAccess": {
16477+
"type": "boolean",
16478+
"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'."
16479+
},
1627216480
"commandType": {
1627316481
"type": "string",
1627416482
"readOnly": true

0 commit comments

Comments
 (0)