UNPKG

@itentialopensource/adapter-redis_cloud

Version:

This adapter integrates with system described as: redisCloud.

1,275 lines (1,274 loc) 329 kB
openapi: 3.0.0 info: title: Redis Cloud API description: Redis Cloud API contact: name: Customer Support url: https://support.redislabs.com email: support@redis.com version: 'Version 1' servers: - url: https://api.redislabs.com/v1 variables: {} paths: /regions: get: tags: - Account summary: getSupportedRegions description: Lookup list of regions for cloud provider operationId: getSupportedRegions parameters: - name: provider in: query description: Provider Name style: form explode: true schema: allOf: - $ref: '#/components/schemas/Provider2' - description: Provider Name responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/Regions' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false /payment-methods: get: tags: - Account summary: getAccountPaymentMethods description: Lookup list of current Account's payment methods operationId: getAccountPaymentMethods parameters: [] responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/PaymentMethods' - description: RedisLabs Account payment methods '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false /logs: get: tags: - Account summary: getAccountSystemLogs description: System log information for current account operationId: getAccountSystemLogs parameters: - name: offset in: query description: Number of items to skip style: form explode: true schema: type: integer format: int32 example: 0 - name: limit in: query description: Maximum number of items to return style: form explode: true schema: type: integer format: int32 example: 100 responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/AccountSystemLogEntries' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false /database-modules: get: tags: - Account summary: getSupportedDatabaseModules description: Lookup list of database modules supported in current account (support may differ based on subscription and database settings) operationId: getSupportedDatabaseModules parameters: [] responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ModulesData' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false /data-persistence: get: tags: - Account summary: getDataPersistenceOptions description: Lookup list of data persistence values operationId: getDataPersistenceOptions parameters: [] responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DataPersistenceOptions' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false /: get: tags: - Account summary: getCurrentAccount description: Current account and related information operationId: getCurrentAccount parameters: [] responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/RootAccount' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false /subscriptions/{subscriptionId}: get: tags: - Subscriptions - Flexible summary: getSubscriptionById description: Information on subscription identified by subscription Id operationId: getSubscriptionById parameters: - name: subscriptionId in: path description: Subscription Id required: true style: simple schema: type: integer format: int32 responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Subscription' - description: RedisLabs Subscription information '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false put: tags: - Subscriptions - Flexible summary: updateSubscription description: Update an existing subscription by Id operationId: updateSubscription parameters: - name: subscriptionId in: path description: Subscription Id required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/SubscriptionUpdateRequest' required: true responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TaskStateUpdate' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '408': description: Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period headers: {} content: {} '409': description: Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name) headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false delete: tags: - Subscriptions - Flexible summary: deleteSubscriptionById description: Delete a subscription identified by subscription Id (subscription must be empty, i.e. cannot contain databases) operationId: deleteSubscriptionById parameters: - name: subscriptionId in: path description: Subscription Id required: true style: simple schema: type: integer format: int32 responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TaskStateUpdate' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '408': description: Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period headers: {} content: {} '409': description: Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name) headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false /subscriptions/{subscriptionId}/regions/peerings/{peeringId}: put: tags: - Subscriptions - Flexible summary: updateActiveActiveVpcPeering description: Update an existing VPC peering in an existing active-active subscription. operationId: updateActiveActiveVpcPeering parameters: - name: subscriptionId in: path description: Subscription Id required: true style: simple schema: type: integer format: int32 - name: peeringId in: path description: VpcPeering Id required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/ActiveActiveVpcPeeringUpdateAwsRequest' required: true responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TaskStateUpdate' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '408': description: Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period headers: {} content: {} '409': description: Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name) headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false delete: tags: - Subscriptions - Flexible summary: deleteActiveActiveVpcPeering description: Delete a VPC peering from an existing active-active subscription. operationId: deleteActiveActiveVpcPeering parameters: - name: subscriptionId in: path description: Subscription Id required: true style: simple schema: type: integer format: int32 - name: peeringId in: path description: VpcPeering Id required: true style: simple schema: type: integer format: int32 responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TaskStateUpdate' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '408': description: Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period headers: {} content: {} '409': description: Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name) headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false /subscriptions/{subscriptionId}/peerings/{peeringId}: put: tags: - Subscriptions - Flexible summary: updateVpcPeering description: Update an existing VPC peering in an existing subscription. operationId: updateVpcPeering parameters: - name: subscriptionId in: path description: Subscription Id required: true style: simple schema: type: integer format: int32 - name: peeringId in: path description: VpcPeering Id required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/VpcPeeringUpdateAwsRequest' required: true responses: '202': description: Accepted headers: {} content: application/json: schema: $ref: '#/components/schemas/TaskStateUpdate' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '408': description: Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period headers: {} content: {} '409': description: Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name) headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false delete: tags: - Subscriptions - Flexible summary: deleteVpcPeering description: Deletes a VPC peering identified by an id operationId: deleteVpcPeering parameters: - name: subscriptionId in: path description: Subscription Id required: true style: simple schema: type: integer format: int32 - name: peeringId in: path description: VpcPeering Id required: true style: simple schema: type: integer format: int32 responses: '202': description: Accepted headers: {} content: application/json: schema: $ref: '#/components/schemas/TaskStateUpdate' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '408': description: Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period headers: {} content: {} '409': description: Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name) headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false /subscriptions/{subscriptionId}/cidr: get: tags: - Subscriptions - Flexible summary: getCidrWhiteList description: Get CIDR whitelist operationId: getCidrWhiteList parameters: - name: subscriptionId in: path description: Subscription Id required: true style: simple schema: type: integer format: int32 responses: '202': description: Accepted headers: {} content: application/json: schema: $ref: '#/components/schemas/TaskStateUpdate' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false put: tags: - Subscriptions - Flexible summary: updateSubscriptionCidrWhiteList description: Update subscription CIDR whitelist operationId: updateSubscriptionCidrWhiteList parameters: - name: subscriptionId in: path description: Subscription Id required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/CidrWhiteListUpdateRequest' required: true responses: '202': description: Accepted headers: {} content: application/json: schema: $ref: '#/components/schemas/TaskStateUpdate' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '408': description: Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period headers: {} content: {} '409': description: Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name) headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false /subscriptions: get: tags: - Subscriptions - Flexible summary: getAllSubscriptions description: Information on current account's subscriptions operationId: getAllSubscriptions parameters: [] responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/AccountSubscriptions' - description: RedisLabs list of subscriptions in current account '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false post: tags: - Subscriptions - Flexible summary: createSubscription description: Create a new subscription operationId: createSubscription parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/SubscriptionCreateRequest' - example: name: My new subscription dryRun: false deploymentType: single-region paymentMethod: credit-card paymentMethodId: 0 memoryStorage: ram persistentStorageEncryption: true cloudProviders: - provider: AWS cloudAccountId: 1 regions: - region: us-east-1 multipleAvailabilityZones: false preferredAvailabilityZones: - string networking: deploymentCIDR: 10.0.0.0/24 vpcId: <vpc-identifier> databases: - name: Redis-database-example protocol: redis memoryLimitInGb: 1 supportOSSClusterApi: false dataPersistence: none replication: true throughputMeasurement: by: operations-per-second value: 10000 localThroughputMeasurement: - region: string writeOperationsPerSecond: 0 readOperationsPerSecond: 0 modules: - name: string parameters: {} quantity: 1 averageItemSizeInBytes: 0 example: name: My new subscription dryRun: false deploymentType: single-region paymentMethod: credit-card paymentMethodId: 0 memoryStorage: ram persistentStorageEncryption: true cloudProviders: - provider: AWS cloudAccountId: 1 regions: - region: us-east-1 multipleAvailabilityZones: false preferredAvailabilityZones: - string networking: deploymentCIDR: 10.0.0.0/24 vpcId: <vpc-identifier> databases: - name: Redis-database-example protocol: redis memoryLimitInGb: 1 supportOSSClusterApi: false dataPersistence: none replication: true throughputMeasurement: by: operations-per-second value: 10000 localThroughputMeasurement: - region: string writeOperationsPerSecond: 0 readOperationsPerSecond: 0 modules: - name: string parameters: {} quantity: 1 averageItemSizeInBytes: 0 required: true responses: '202': description: Accepted headers: {} content: application/json: schema: $ref: '#/components/schemas/TaskStateUpdate' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to create requested resource (primarily due to not active resource) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '408': description: Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period headers: {} content: {} '409': description: Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with the new name headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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 headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false /subscriptions/{subscriptionId}/regions: get: tags: - Subscriptions - Flexible summary: getRegionsFromActiveActiveSubscription description: Get all regions of an active-active subscription operationId: getRegionsFromActiveActiveSubscription parameters: - name: subscriptionId in: path description: Subscription Id required: true style: simple schema: type: integer format: int32 responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ActiveActiveSubscriptionRegions' - description: List of active-active subscription regions '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {} '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) headers: {} content: {} '500': description: Internal system error - If this error persists, please contact customer support headers: {} content: {} '503': description: Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support headers: {} content: {} deprecated: false post: tags: - Subscriptions - Flexible summary: addNewRegionToActiveActiveSubscription description: Create a new region in an active-active subscription operationId: addNewRegionToActiveActiveSubscription parameters: - name: subscriptionId in: path description: Subscription Id required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/ActiveActiveRegionCreateRequest' required: true responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TaskStateUpdate' '400': description: Bad Request - The server cannot process the request due to something that is perceived to be a client error headers: {} content: {} '401': description: Unauthorized - Authentication failed for requested resource headers: {} content: {} '403': description: Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions) headers: {} content: {} '404': description: Not Found - The resource you were trying to reach was not found or does not exist headers: {} content: {} '408': description: Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period headers: {} content: {} '409': description: Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name) headers: {} content: {} '412': description: Precondition Failed - Feature flag for this flow is off headers: {} content: {}