Skip to content

Commit 836a39d

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

File tree

1 file changed

+191
-3
lines changed

1 file changed

+191
-3
lines changed

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

Lines changed: 191 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@
4141
"description": "All Pro subscription connectivity operations.",
4242
"x-order": "11"
4343
},
44+
{
45+
"name": "Subscriptions - Dedicated",
46+
"description": "All Dedicated subscription operations.",
47+
"x-order": "11"
48+
},
4449
{
4550
"name": "Databases - Pro",
4651
"description": "All Pro database operations.",
@@ -3077,7 +3082,7 @@
30773082
],
30783083
"summary": "Get a single Essentials subscription",
30793084
"description": "Gets information on the specified Essentials subscription.",
3080-
"operationId": "getSubscriptionById_1",
3085+
"operationId": "getSubscriptionById_2",
30813086
"parameters": [
30823087
{
30833088
"name": "subscriptionId",
@@ -6566,6 +6571,71 @@
65666571
}
65676572
}
65686573
},
6574+
"/subscriptions/dedicated": {
6575+
"post": {
6576+
"tags": [
6577+
"Subscriptions - Dedicated"
6578+
],
6579+
"summary": "Create Dedicated subscription",
6580+
"description": "Creates a new Redis Cloud Dedicated subscription.",
6581+
"operationId": "createSubscription_1",
6582+
"requestBody": {
6583+
"content": {
6584+
"application/json": {
6585+
"schema": {
6586+
"$ref": "#/components/schemas/SubscriptionCreateRequest"
6587+
}
6588+
}
6589+
},
6590+
"required": true
6591+
},
6592+
"responses": {
6593+
"400": {
6594+
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
6595+
},
6596+
"412": {
6597+
"description": "Precondition Failed - Feature flag for this flow is off"
6598+
},
6599+
"202": {
6600+
"description": "Accepted",
6601+
"content": {
6602+
"application/json": {
6603+
"schema": {
6604+
"$ref": "#/components/schemas/TaskStateUpdate"
6605+
}
6606+
}
6607+
}
6608+
},
6609+
"401": {
6610+
"description": "Unauthorized - Authentication failed for requested resource"
6611+
},
6612+
"403": {
6613+
"description": "Forbidden - Not allowed to create requested resource (primarily due to not active resource)"
6614+
},
6615+
"404": {
6616+
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
6617+
},
6618+
"408": {
6619+
"description": "Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period"
6620+
},
6621+
"409": {
6622+
"description": "Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with the new name"
6623+
},
6624+
"422": {
6625+
"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"
6626+
},
6627+
"429": {
6628+
"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)"
6629+
},
6630+
"500": {
6631+
"description": "Internal system error - If this error persists, please contact customer support"
6632+
},
6633+
"503": {
6634+
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
6635+
}
6636+
}
6637+
}
6638+
},
65696639
"/fixed/subscriptions": {
65706640
"get": {
65716641
"tags": [
@@ -6617,7 +6687,7 @@
66176687
],
66186688
"summary": "Create Essentials subscription",
66196689
"description": "Creates a new Essentials subscription.",
6620-
"operationId": "createSubscription_1",
6690+
"operationId": "createSubscription_2",
66216691
"requestBody": {
66226692
"content": {
66236693
"application/json": {
@@ -8577,6 +8647,64 @@
85778647
}
85788648
}
85798649
},
8650+
"/subscriptions/dedicated/{subscriptionId}": {
8651+
"get": {
8652+
"tags": [
8653+
"Subscriptions - Dedicated"
8654+
],
8655+
"summary": "Get a single dedicated subscription",
8656+
"description": "Gets information on the specified dedicated subscription.",
8657+
"operationId": "getSubscriptionById_1",
8658+
"parameters": [
8659+
{
8660+
"name": "subscriptionId",
8661+
"in": "path",
8662+
"description": "Subscription ID.",
8663+
"required": true,
8664+
"schema": {
8665+
"type": "integer",
8666+
"format": "int32"
8667+
}
8668+
}
8669+
],
8670+
"responses": {
8671+
"400": {
8672+
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
8673+
},
8674+
"412": {
8675+
"description": "Precondition Failed - Feature flag for this flow is off"
8676+
},
8677+
"200": {
8678+
"description": "OK",
8679+
"content": {
8680+
"application/json": {
8681+
"schema": {
8682+
"$ref": "#/components/schemas/DedicatedSubscription"
8683+
}
8684+
}
8685+
}
8686+
},
8687+
"401": {
8688+
"description": "Unauthorized - Authentication failed for requested resource"
8689+
},
8690+
"403": {
8691+
"description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"
8692+
},
8693+
"404": {
8694+
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
8695+
},
8696+
"429": {
8697+
"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)"
8698+
},
8699+
"500": {
8700+
"description": "Internal system error - If this error persists, please contact customer support"
8701+
},
8702+
"503": {
8703+
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
8704+
}
8705+
}
8706+
}
8707+
},
85808708
"/session-logs": {
85818709
"get": {
85828710
"tags": [
@@ -10161,6 +10289,11 @@
1016110289
"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'",
1016210290
"example": true
1016310291
},
10292+
"redisVersion": {
10293+
"type": "string",
10294+
"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')",
10295+
"example": "7.4"
10296+
},
1016410297
"respVersion": {
1016510298
"type": "string",
1016610299
"description": "Optional. Redis Serialization Protocol version. Must be compatible with Redis version.",
@@ -13553,6 +13686,60 @@
1355313686
},
1355413687
"description": "Database tag"
1355513688
},
13689+
"DedicatedSubscription": {
13690+
"type": "object",
13691+
"properties": {
13692+
"id": {
13693+
"type": "integer",
13694+
"description": "Unique identifier for the subscription",
13695+
"format": "int32"
13696+
},
13697+
"name": {
13698+
"type": "string",
13699+
"description": "Name of the subscription"
13700+
},
13701+
"paymentMethodId": {
13702+
"type": "integer",
13703+
"description": "Payment method identifier",
13704+
"format": "int32"
13705+
},
13706+
"status": {
13707+
"type": "string",
13708+
"description": "Current status of the subscription"
13709+
},
13710+
"memoryStorage": {
13711+
"type": "string",
13712+
"description": "Memory storage configuration for the subscription",
13713+
"enum": [
13714+
"ram",
13715+
"ram-and-flash"
13716+
]
13717+
},
13718+
"numberOfDatabases": {
13719+
"type": "integer",
13720+
"description": "Number of databases in the subscription",
13721+
"format": "int32"
13722+
},
13723+
"paymentMethodType": {
13724+
"type": "string",
13725+
"description": "Type of payment method used",
13726+
"enum": [
13727+
"credit-card",
13728+
"marketplace"
13729+
]
13730+
},
13731+
"links": {
13732+
"type": "array",
13733+
"items": {
13734+
"type": "object",
13735+
"additionalProperties": {
13736+
"type": "object"
13737+
}
13738+
}
13739+
}
13740+
},
13741+
"description": "Redis Dedicated Subscription information"
13742+
},
1355613743
"SubscriptionSpec": {
1355713744
"required": [
1355813745
"regions"
@@ -14433,6 +14620,7 @@
1443314620
"DATABASE_AVERAGE_ITEM_SIZE_INVALID_VALUE",
1443414621
"DATABASE_REDIS_VERSION_IS_NOT_SUPPORTED",
1443514622
"DATABASE_REDIS_VERSION_IS_NOT_SUPPORTED_FOR_MEMCACHED",
14623+
"DATABASE_REDIS_VERSION_IS_REQUIRED",
1443614624
"DATABASE_REDIS_VERSION_INVALID_VALUE",
1443714625
"VPC_PEERING_NOT_ACTIVE",
1443814626
"VPC_PEERING_GENERAL_ERROR",
@@ -15234,7 +15422,7 @@
1523415422
"readOnly": true
1523515423
}
1523615424
},
15237-
"description": "Subscription create request"
15425+
"description": "Dedicated Subscription create request"
1523815426
},
1523915427
"RedisVersions": {
1524015428
"type": "object",

0 commit comments

Comments
 (0)