openapi: 3.2.0 info: title: Redis Cloud Databases - Essentials 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 security: - x-api-key: [] x-api-secret-key: [] x-auth-token: [] tags: - name: Databases - Essentials description: All Essentials database operations. x-order: '40' paths: /v1/fixed/subscriptions/{subscriptionId}/databases/{databaseId}: get: tags: - Databases - Essentials summary: Get a single Essentials database description: Gets details and settings of a single database in an Essentials subscription. operationId: getSubscriptionDatabaseByID_1 parameters: - name: subscriptionId in: path description: Subscription ID. required: true schema: minimum: 0 type: integer format: int32 - name: databaseId in: path description: Database ID. required: true schema: minimum: 0 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/FixedDatabase' '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 ' put: tags: - Databases - Essentials summary: Update Essentials database description: Updates the specified Essentials database. operationId: deleteFixedDatabaseByID 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/FixedDatabaseUpdateRequest' example: name: Redis-fixed-database-example dataPersistence: none dataEvictionPolicy: allkeys-lru replication: true enableDefaultUser: true alerts: - name: datasets-size value: 80 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 ' delete: tags: - Databases - Essentials summary: Delete Essentials database description: Deletes a database from an Essentials subscription. operationId: deleteFixedDatabaseByID_1 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/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 ' /v1/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/tags: get: tags: - Databases - Essentials summary: Get database tags description: Gets a list of all database tags. operationId: getTags_1 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/CloudTags' '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 ' put: tags: - Databases - Essentials summary: Overwrite database tags description: Overwrites all tags on the database. operationId: updateTags_1 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/DatabaseTagsUpdateRequest' 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/CloudTags' '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 ' post: tags: - Databases - Essentials summary: Add a database tag description: Adds a single database tag to a database. operationId: createTag_1 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/DatabaseTagCreateRequest' 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/CloudTag' '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 ' /v1/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/tags/{tagKey}: put: tags: - Databases - Essentials summary: Update database tag value description: Updates the value of the specified database tag. operationId: updateTag_1 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 - name: tagKey in: path description: Tag Key. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DatabaseTagUpdateRequest' 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/CloudTag' '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 ' delete: tags: - Databases - Essentials summary: Delete database tag description: Removes the specified tag from the database. operationId: deleteTag_1 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 - name: tagKey in: path description: Tag Key. required: true schema: type: string example: environment 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: type: object '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 ' /v1/fixed/subscriptions/{subscriptionId}/databases: get: tags: - Databases - Essentials summary: Get all databases in an Essentials subscription description: Gets a list of all databases in the specified Essentials subscription. operationId: getFixedSubscriptionDatabases parameters: - name: subscriptionId in: path description: Subscription ID. required: true schema: minimum: 0 type: integer format: int32 - name: offset in: query description: Number of items to skip. required: false schema: type: integer format: int32 example: 0 - name: limit in: query description: Maximum number of items to return. required: false schema: type: integer format: int32 example: 100 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/AccountFixedSubscriptionDatabases' '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: Create Essentials database description: Creates a new database in the specified Essentials subscription. operationId: createFixedDatabase parameters: - name: subscriptionId in: path description: Subscription ID. required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/FixedDatabaseCreateRequest' example: name: Redis-fixed-database-example protocol: stack dataPersistence: none dataEvictionPolicy: allkeys-lru replication: true alerts: - name: datasets-size value: 80 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 ' /v1/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/DatabaseVersionUpgradeStatus' '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 ' /v1/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/traffic/resume: post: tags: - Databases - Essentials summary: Resume Essentials database traffic description: Resumes traffic for the specified Essentials database. This is available in private preview. operationId: resumeBdbTraffic_1 parameters: - name: subscriptionId in: path description: Subscription ID. required: true schema: minimum: 0 type: integer format: int32 - name: databaseId in: path description: Database ID. required: true schema: minimum: 0 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: Traffic resumed '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 ' /v1/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/import: get: tags: - Databases - Essentials summary: Get Essentials database import status description: Gets information on the latest import attempt for this Essentials database. operationId: getDatabaseImportStatus_1 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/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: - Databases - Essentials summary: Import data to an Essentials database description: 'Imports data from an RDB file or from a different Redis database into this Essentials database. WARNING: Importing data into a database removes all existing data from the database.' operationId: importDatabase_1 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/FixedDatabaseImportRequest' 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 ' /v1/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/backup: get: tags: - Databases - Essentials summary: Backup Essentials database status description: Information on the latest database backup status identified by Essentials subscription Id and Essentials database Id operationId: getDatabaseBackupStatus_1 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/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: - Databases - Essentials summary: Back up Essentials database description: Manually back up the specified Essentials database to a backup path. By default, backups will be stored in the 'periodicBackupPath' location for this database. operationId: backupDatabase_1 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/FixedDatabaseBackupRequest' 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 ' /v1/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/traffic: get: tags: - Databases - Essentials summary: Get Essentials database traffic description: Gets traffic information for the specified Essentials database. If the database was not a source in a redirect endpoints operation, a not found error will be returned. This is available in private preview. operationId: getDatabaseTraffic_1 parameters: - name: subscriptionId in: path description: Subscription ID. required: true schema: minimum: 0 type: integer format: int32 - name: databaseId in: path description: Database ID. required: true schema: minimum: 0 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/DatabaseTrafficStateResponse' '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 ' /v1/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/slow-log: get: tags: - Databases - Essentials summary: Get Essentials database slow-log by database id description: Get slow-log for a specific database identified by Essentials subscription Id and database Id operationId: getSlowLog_1 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/DatabaseSlowLogEntries' '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 ' /v1/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/DatabaseAvailableVersionsResponse' '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 ' components: schemas: DatabaseSlowLogEntry: type: object properties: id: type: integer format: int32 startTime: type: string format: date-time duration: type: integer format: int32 arguments: type: string description: Database slowlog entry ReplicaAsSourceEndpoints: type: object properties: public: type: string description: Public cluster endpoint that can be used as source for replication private: type: string description: Private cluster endpoint that can be used as source for replication description: Endpoints to use when configuring another database to replicate from this database (Make sure to use this instead of the dynamic endpoints). CloudTags: type: object properties: links: type: array items: type: object additionalProperties: type: string accountId: type: integer format: int32 description: Redis list of database tags example: accountId: 40131 tags: - key: environment value: production createdAt: '2024-05-21T20:02:21+02:00' updatedAt: '2024-06-21T20:02:21+02:00' links: [] - key: owner value: Clifford O'neill createdAt: '2024-05-21T20:02:21+02:00' updatedAt: '2024-06-21T20:02:21+02:00' links: [] links: - rel: self href: http://localhost:8081/v1/fixed/subscriptions/178867/databases/51412930/tags type: GET ProcessorResponse: type: object properties: resourceId: type: integer format: int32 additionalResourceId: type: integer format: int32 resource: type: object error: type: string enum: - UNAUTHORIZED - ACCOUNT_POC_INACTIVE_PENDING - CLOUD_ACCOUNT_NOT_ACTIVE - CLOUD_ACCOUNT_NOT_FOUND - CLOUD_ACCOUNT_USED - CLOUD_ACCOUNT_INVALID_CREDS - CLOUD_ACCOUNT_NAME_EXISTS - CLOUD_ACCOUNT_ACCESS_KEY_EXISTS - CLOUD_ACCOUNT_PERMISSION_FAILED - CLOUD_ACCOUNT_ALLOCATION_FAILURE - NOT_KNOWN_CLOUD_PROVIDER - MULTIPLE_CLOUD_PROVIDERS_NOT_SUPPORTED - SUBSCRIPTION_NOT_ACTIVE - SUBSCRIPTION_CONTAINS_NON_ACTIVE_DATABASE - SUBSCRIPTION_NOT_FOUND - SUBSCRIPTION_IN_USE - SUBSCRIPTION_CA_PROVIDER_MISMATCH - SUBSCRIPTION_NETWORKING_MISSING - NETWORKING_CIDR_MISSING - SUBSCRIPTION_INVALID_CIDR - 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 - SUBSCRIPTION_BAD_PREFERRED_AZ_SIZE - SUBSCRIPTION_REGION_DOES_NOT_SUPPORT_MULTI_AZ - SUBSCRIPTION_AA_NON_MAZ_REGION_NOT_SUPPORTED - SUBSCRIPTION_PREFERRED_AZ_INVALID_VALUE - SUBSCRIPTION_PREFERRED_AZ_MUST_BE_DEFINED_ONCE - SUBSCRIPTION_PREFERRED_AZ_IS_DISABLED - SUBSCRIPTION_MUST_HAVE_AT_LEAST_ONE_DATABASE - SUBSCRIPTION_REDIS_VERSION_INVALID_VALUE - SUBSCRIPTION_REDIS_VERSION_CONFLICT - ACTIVE_ACTIVE_SUBSCRIPTION_PREVIEW_REDIS_VERSION_IS_NOT_SUPPORTED - 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 - 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_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_DELETION_GRACE_PERIOD_REQUIRED - 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_UPDATE_IS_NOT_SUPPORTED - CUSTOMER_MANAGED_PERSISTENT_STORAGE_ENCRYPTION_KEY_SUBSCRIPTION_INVALID_STATUS - 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 - PLANNER_NOT_ENOUGH_AZS - PLANNER_INVALID_INSTANCE_TYPE_PER_AZ - PLANNER_MODULE_PLAN_CLUSTERING_ERROR - PLANNER_MODULE_PLAN_RESHARDING_ERROR - PLANNER_INVALID_PLAN - PLANNER_INVALID_SIZE - PLANNER_INVALID_NUMBER - PLANNER_INVALID_THROUGHPUT - PROVISION_FAILURE - DATABASE_NOT_ACTIVE - DATABASE_NOT_FOUND - DATABASE_SUBSCRIPTION_MISMATCH - DATABASE_CANT_EDIT_THROUGHPUT_BY - DATABASE_INVALID_SHARDS_COUNT - DATABASE_CONTAIN_MEMCACHED_USERNAME - DATABASE_CONTAIN_MEMCACHED_PASSWORD - DATABASE_SUBSCRIPTION_IN_PENDING_STATUS - DATABASE_THROUGHPUT_TOO_BIG - DATABASE_INVALID_THROUGHPUT_INCREMENT - DATABASE_MODULE_NOT_SUPPORTING_SHARD_THROUGHPUT_OPTION - DATABASE_MODULE_NOT_SUPPORTED - DATABASE_QUERY_PERFORMANCE_FACTOR_INVALID_VALUE - DATABASE_QUERY_PERFORMANCE_FACTOR_SEARCH_IS_REQUIRED - DATABASE_QUERY_PERFORMANCE_FACTOR_IS_NOT_SUPPORTED - DATABASE_QUERY_PERFORMANCE_FACTOR_IS_NOT_SUPPORTED_ON_ACTIVE_ACTIVE - REDISEARCH_SUPPORTS_ONLY_OPERATIONS_PER_SECOND_AS_THROUGHPUT_MEASUREMENT - REDIS_GRAPH_SUPPORTS_ONLY_OPS_PER_SECOND_AS_THROUGHPUT_MEASUREMENT - DATABASE_RESP_VERSION_IS_NOT_SUPPORTED - DATABASE_RESP_VERSION_IS_NOT_SUPPORTED_ON_CREATE_SUBSCRIPTION - DATABASE_ROF_NOT_SUPPORTED - DATABASE_REDISGRAPH_OVERSIZED - DATABASE_BACKUP_NOT_SUPPORTED - DATABASE_EVICTION_NOT_SUPPORTED - DATABASE_AOF_NOT_SUPPORTED - DATABASE_REPLICA_OF_NOT_SUPPORTED - DATABASE_SNAPSHOT_NOT_SUPPORTED - DATABASE_CLUSTERING_NOT_SUPPORTED - DATABASE_INVALID_THREAD_NUMBER - DATABASE_HASH_NOT_SUPPORTED - DATABASE_RESHARD_NOT_SUPPORTED - DATABASE_FEATURE_NOT_SUPPORTED - DATABASE_NAME_EXISTS - DATABASE_NAME_DUPLICATE - DATABASE_INVALID_NAME - DATABASE_NAME_TOO_LONG - DATABASE_SIZE_TOO_SMALL - DATABASE_SIZE_TOO_BIG - DATABASE_SIZE_LIMIT_NOT_DEFINED - DATABASE_SIZE_LIMIT_INVALID_TOO_MANY_MEMORY_SPECIFICATIONS - DATABASE_PASSWORD_IS_BLANK - DATABASE_PASSWORD_IS_TOO_LONG - DATABASE_REDIS_SEARCH_MODULE_VALUE_IS_NOT_INTEGER - DATABASE_REDIS_SEARCH_MODULE_VALUE_NOT_IN_RANGE - 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 - DATABASE_MEMCACHED_SASL_PASSWORD_IS_BLANK - 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 - DATABASE_INVALID_CERT - DATABASE_EXPIRED_CERT - DATABASE_MISSING_CERT - DATABASE_CLIENT_SSL_CERTIFICATE_DEPRECATED - DATABASE_CLIENT_SSL_CERTIFICATE_MORE_THAN_1_ACTIVE - DATABASE_SIP_OVER_LIMIT - DATABASE_INVALID_SIP - DATABASE_INVALID_SIP_FREE_PLAN - DATABASE_INVALID_ALERTS - 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 - DATABASE_REGEX_RULES_NO_CLUSTERING - DATABASE_REGEX_RULES_CHANGES_BLOCKED - DATABASE_OSS_CLUSTER_NOT_SUPPORTED - DATABASE_EXTERNAL_ENDPOINT_WITHOUT_OSS_CLUSTER - CUSTOM_REGEX_RULES_IS_NOT_ALLOWED_WITHOUT_ENABLE_DATABASE_CLUSTERING_IS_TRUE - DATABASE_OSS_CLUSTER_CUSTOM_REGEX_NOT_SUPPORTED - DATABASE_OSS_CLUSTER_REPLICA_NOT_SUPPORTED - DATABASE_REPLICA_OF_PROPERTY_DEPRECATED - DATABASE_REPLICA_PER_SOURCE_OVER_LIMIT - DATABASE_REPLICA_CYCLE - DATABASE_INVALID_REPLICA - DATABASE_UNSUPPORTED_REPLICA_OF_REDIS_FLEX - DATABASE_REPLICAS_OVER_LIMIT - DATABASE_BACKUP_DISABLED - DATABASE_BACKUP_FAILED - DATABASE_BACKUP_NOT_CONFIGURED - DATABASE_INVALID_BACKUP_PATH - DATABASE_INVALID_BACKUP_INTERVAL - DATABASE_INVALID_TOO_MANY_BACKUP_SPECIFICATIONS - DATABASE_INVALID_BACKUP_STORAGE_TYPE - DATABASE_INVALID_IMPORT_SOURCE_TYPE - DATABASE_INVALID_BACKUP_TIME_UTC - DATABASE_INVALID_BACKUP_INTERVAL_AND_TIME_UTC_MISMATCH - DATABASE_INVALID_BACKUP_PATH_USED_BY_ANOTHER_ACCOUNT - DATABASE_INVALID_BACKUP_CONFIGURATION - DATABASE_INVALID_REGEX_RULES - DATABASE_INVALID_QUANTITY - DATABASE_REPLICA_OF_VERSION_NOT_COMPATIBLE - DATABASE_REPLICA_OF_SOURCE_INCOMPATIBLE - DATABASE_IMPORT_FAILED - DATABASE_IMPORT_FROM_NON_OSS - DATABASE_IMPORT_SOURCE_NOT_FOUND - DUPLICATE_DATABASE_IMPORT_SOURCE_PATH - DATABASE_IMPORT_WRONG_SIZE - DATABASE_IMPORT_URI_NOT_PROVIDED - DATABASE_IMPORT_MULTIPLE_REDIS_SOURCES - DATABASE_IMPORT_REDIS_BAD_URI - DATABASE_REPLICA_OF_BAD_URI - DATABASE_IMPORT_S3_BAD_URI - DATABASE_IMPORT_HTTP_BAD_URI - DATABASE_IMPORT_FTP_BAD_URI - DATABASE_IMPORT_AZURE_BAD_URI - DATABASE_IMPORT_GCS_BAD_URI - DATABASE_IMPORT_NOT_ALLOWED - 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_REGION - DATABASE_REDIS_VERSION_IS_NOT_SUPPORTED_FOR_MEMCACHED - DATABASE_REDIS_VERSION_IS_REQUIRED - DATABASE_REDIS_VERSION_INVALID_VALUE - INCOMPATIBLE_TF_PROVIDER - DESIRED_SOFTWARE_VERSION_IS_NOT_SUPPORTED - CONNECTIVITY_REQUESTS_ON_CUSTOMER_MANAGED_VPC_SUBSCRIPTION - VPC_PEERING_NOT_ACTIVE - VPC_PEERING_GENERAL_ERROR - VPC_PEERING_INVALID_ACCOUNT - VPC_PEERING_INVALID_VPC - VPC_PEERING_INVALID_CIDR - VPC_PEERING_CIDR_IS_MISSING - VPC_PEERING_TOO_MANY_CIDR_SPECIFICATIONS - VPC_PEERING_INVALID_REGION - VPC_PEERING_ALREADY_EXIST - VPC_PEERING_NOT_FOUND - VPC_PEERING_INVALID_PROJECT - VPC_PEERING_CLUSTER_NOT_ACTIVE - VPC_PEERING_CIDR_OVERLAP - VPC_PEERING_BELONGS_TO_DIFFERENT_CLOUD_PROVIDER - VPC_PEERING_IS_NOT_KNOWN_CLOUD_PROVIDER - CREATING_AN_ACTIVE_ACTIVE_VPC_PEERING_IS_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - UPDATING_AN_ACTIVE_ACTIVE_VPC_PEERING_IS_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - DELETING_AN_ACTIVE_ACTIVE_VPC_PEERING_IS_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - DELETING_AN_ACTIVE_ACTIVE_VPC_PEERING_IS_NOT_ALLOWED_FOR_A_SUBSCRIPTION_WITH_NO_VPC_PEERINGS - ACTIVE_ACTIVE_VPC_PEERING_NOT_FOUND - VPC_PEERING_MULTIPLE_CIDRS_IS_DISABLED - TGW_ACCEPTING_AN_ACTIVE_ACTIVE_TGW_RESOURCE_SHARE_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - TGW_REJECTING_AN_ACTIVE_ACTIVE_TGW_RESOURCE_SHARE_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - TGW_ACCEPTING_A_FLEXIBLE_SUBSCRIPTION_TGW_RESOURCE_SHARE_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION - TGW_REJECTING_A_FLEXIBLE_SUBSCRIPTION_TGW_RESOURCE_SHARE_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION - TGW_CREATING_AN_ACTIVE_ACTIVE_SUBSCRIPTION_TGW_ATTACHMENT_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - TGW_DELETING_AN_ACTIVE_ACTIVE_SUBSCRIPTION_TGW_ATTACHMENT_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - TGW_UPDATING_AN_ACTIVE_ACTIVE_TGW_ATTACHMENT_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - TGW_CREATING_A_FLEXIBLE_SUBSCRIPTION_TGW_ATTACHMENT_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION - TGW_UPDATING_A_FLEXIBLE_SUBSCRIPTION_TGW_ATTACHMENT_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION - TGW_DELETING_A_FLEXIBLE_SUBSCRIPTION_TGW_ATTACHMENT_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION - TGW_CLOUD_PROVIDER_IS_NOT_SUPPORTED - TGW_RESOURCE_SHARE_DOES_NOT_EXIST - TGW_DOES_NOT_EXIST - TGW_ATTACHMENT_DOES_NOT_EXIST - TGW_ATTACHMENT_IS_NOT_ACTIVE - TGW_ATTACHMENT_CIDRS_INVALID_LENGTH - TGW_ATTACHMENT_CIDRS_ARE_THE_SAME_AS_EXISTING_ONES - TGW_ATTACHMENT_CIDRS_REQUEST_CONTAINS_DUPLICATES - TGW_REGION_DOES_NOT_EXIST - TGW_GETTING_ACTIVE_ACTIVE_SUBSCRIPTION_TGW_IS_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - TGW_GETTING_ACTIVE_ACTIVE_SUBSCRIPTION_TGW_INVITATIONS_IS_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - TGW_GETTING_SINGLE_REGION_TGWS_IS_NOT_ALLOWED_WITH_ACTIVE_ACTIVE_SUBSCRIPTION - TGW_GETTING_SINGLE_REGION_TGW_INVITATIONS_IS_NOT_ALLOWED_WITH_ACTIVE_ACTIVE_SUBSCRIPTION - PSC_ENDPOINT_INVALID_GCP_PROJECT_ID - PSC_ENDPOINT_INVALID_VPC_NAME - PSC_ENDPOINT_INVALID_VPC_SUBNET_NAME - PSC_ENDPOINT_INVALID_CONNECTION_NAME - PSC_SERVICE_ALREADY_EXISTS - PSC_ENDPOINT_ALREADY_EXISTS - PSC_CLOUD_PROVIDER_IS_NOT_SUPPORTED - PSC_GET_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_ENDPOINTS_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - PSC_GET_A_FLEXIBLE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_ENDPOINT_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION - PSC_CREATING_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - PSC_CREATING_A_FLEXIBLE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION - PSC_DELETING_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - PSC_DELETING_A_FLEXIBLE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION - PSC_CREATING_A_FLEXIBLE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_ENDPOINT_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION - PSC_CREATING_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_ENDPOINT_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - PSC_CREATING_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_IS_NOT_SUPPORTED - PSC_UPDATING_A_FLEXIBLE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_ENDPOINT_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION - PSC_UPDATING_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_ENDPOINT_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - PSC_DELETING_A_FLEXIBLE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_ENDPOINT_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION - PSC_DELETING_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_SERVICE_CONNECT_ENDPOINT_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - PSC_UPDATE_ENDPOINT_REQUEST_ACTION_INVALID_VALUE - PSC_UPDATE_ENDPOINT_REQUEST_CANNOT_HAVE_BOTH_ACTION_AND_OTHER_FIELDS - PSC_UPDATE_ENDPOINT_REQUEST_CANNOT_UPDATE_INITIALIZED_ENDPOINT - PSC_SERVICE_NOT_FOUND - PSC_ENDPOINT_NOT_FOUND - PSC_ENDPOINT_NOT_ACTIVE - PSC_ENDPOINT_NOT_CREATED_OR_DELETED - PSC_ENDPOINT_CANNOT_BE_DELETED_WITHOUT_DELETION_SCRIPT - PSC_SERVICE_CANNOT_DELETE_SERVICE_WITH_ACTIVE_ENDPOINTS - PSC_SERVICE_NOT_ACTIVE - PSC_ENDPOINT_SCRIPT_FAILED_TO_PARSE - CIDR_WHITELIST_GENERAL_ERROR - CIDR_WHITELIST_INVALID_CIDRS - CIDR_WHITELIST_INVALID_SG - CIDR_WHITELIST_LIMIT_EXCEEDED - 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 - AWS_ERROR_VOLUME_LIMIT_EXCEEDED - AWS_ERROR_MISMATCHING_CIDR - AWS_ERROR_CONFLICTING_CIDR - AWS_ERROR_VPC_DOES_NOT_EXIST - AWS_ERROR_EXISTING_VPC_EQUAL_TO_REQUESTED - PAYMENT_INFO_NOT_PROVIDED - PAYMENT_INFO_EXPIRED - PAYMENT_INFO_NOT_ALLOWED_IN_GCP_ACCOUNT - CLOUD_PROVIDER_IS_NOT_GCP_IN_GCP_ACCOUNT - PAYMENT_INFO_NOT_ALLOWED_IN_CONTRACT_ASSOCIATED_ACCOUNT - PAYMENT_INFO_CHANGE_PROHIBITED_FOR_PRO_UNDER_CONTRACT - LOCAL_THROUGHPUT_READ_AND_WRITE_OPERATIONS_PER_SECOND_VALUES_MUST_BE_IN_INCREMENTS_OF_500_OR_MINIMUM - MISSING_REGIONS_BETWEEN_CLOUD_PROVIDERS_AND_DATABASES_LOCAL_THROUGHPUT_MEASUREMENTS - MISSING_REGIONS_BETWEEN_LOCAL_THROUGHPUT_MEASUREMENTS_AND_SUBSCRIPTION_REGIONS - CRDB_ACTIVE_ACTIVE_MISSING_LOCAL_THROUGHPUT_MEASUREMENT - CRDB_ACTIVE_ACTIVE_REGIONS_MUST_BE_DEFINED_ONCE - ACTIVE_ACTIVE_CREATE_A_REGION_MUST_CONTAIN_DATABASE_SPEC_TO_ALL_CRDBS_IN_SUBSCRIPTION - ACTIVE_ACTIVE_CREATE_A_REGION_MUST_CONTAIN_LOCAL_THROUGHPUT_MEASUREMENT_IN_DATABASE_SPEC - 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_RAM_AND_FLASH_MEMORY_STORAGE_NOT_SUPPORTED - ACTIVE_ACTIVE_DATABASE_MODULE_IS_NOT_SUPPORTED - ACTIVE_ACTIVE_DATABASE_MODULES_IS_NOT_SUPPORTED - ACTIVE_ACTIVE_FOR_GCP_ACCOUNT_IS_NOT_SUPPORTED - ACTIVE_ACTIVE_DATABASE_ALERT_NOT_SUPPORTED - FLEXIBLE_DATABASE_ALERT_NOT_SUPPORTED - ACTIVE_ACTIVE_DATABASE_REPLICA_OF_NOT_SUPPORTED - ACTIVE_ACTIVE_DATABASE_PERIODIC_BACK_UP_PATH_NOT_ALLOWED - ACTIVE_ACTIVE_CHANGE_REQUEST_PLANNING_FAILED - ACTIVE_ACTIVE_CHANGE_REQUEST_PLANNING_EXPIRED - ACTIVE_ACTIVE_MISSING_LOCAL_THROUGHPUT_MEASUREMENT - ACTIVE_ACTIVE_BACKUP_MISSING_REGION_NAME - ACTIVE_ACTIVE_BACKUP_STATUS_MISSING_REGION_NAME - ACTIVE_ACTIVE_DATABASE_INVALID_CIDR_FORMAT - ACTIVE_ACTIVE_DATABASE_INVALID_CIDR_OVERLAPPING_OTHER_REGIONS - ACTIVE_ACTIVE_DATABASE_REPLICATION_CANNOT_BE_FALSE - ACTIVE_ACTIVE_REGIONS_MUST_BE_DEFINED_ONCE - ACTIVE_ACTIVE_SUBSCRIPTION_WITHOUT_REGIONS_IS_NOT_ALLOWED - ACTIVE_ACTIVE_DATABASE_MEMCACHED_PROTOCOL_IS_NOT_ALLOWED - ACTIVE_ACTIVE_DATABASE_SHARDING_MUST_BE_ENABLED - ACTIVE_ACTIVE_DATABASE_MISSING_DATABASE_CONFIGURATION - ACTIVE_ACTIVE_DATABASE_INVALID_THROUGHPUT - ACTIVE_ACTIVE_MISMATCH_BETWEEN_REQUEST_REGIONS_AND_SUBSCRIPTION_REGIONS - ACTIVE_ACTIVE_INVALID_UPDATE_DATABASE_NAME - ACTIVE_ACTIVE_INVALID_CREATE_REGION_NAME - ACTIVE_ACTIVE_INVALID_DELETE_REGION_NAME - ACTIVE_ACTIVE_INVALID_BACKUP_REGION_NAME - ACTIVE_ACTIVE_INVALID_BACKUP_STATUS_REGION_NAME - ACTIVE_ACTIVE_DELETE_REGIONS_MUST_BE_DEFINED_ONCE - ACTIVE_ACTIVE_DELETE_SUBSCRIPTION_MUST_BE_DEPLOYED_IN_AT_LEAST_ONE_REGION - ACTIVE_ACTIVE_REQUEST_GENERAL_ERROR - ACTIVE_ACTIVE_VPC_PEERING_INVALID_SOURCE_REGION_NAME - ACTIVE_ACTIVE_VPC_PEERING_INVALID_AWS_ACCOUNT - ACTIVE_ACTIVE_DATABASE_RESP_VERSION_IS_NOT_SUPPORTED - ACTIVE_ACTIVE_DATABASE_PREVIEW_REDIS_VERSION_IS_NOT_SUPPORTED - ACTIVE_ACTIVE_DATABASE_UPGRADE_IS_NOT_SUPPORTED - LOCAL_THROUGHPUT_MEASUREMENT_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - BACKUP_REGION_NAME_IS_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - BACKUP_STATUS_REGION_NAME_IS_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - UPDATING_LOCAL_PROPERTIES_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - DISABLING_THE_DEFAULT_USER_AND_UPDATING_A_NEW_PASSWORD_IS_NOT_ALLOWED - NOT_ALLOWED_TO_UPDATE_A_DATABASE_PASSWORD_WHEN_DEFAULT_USER_IS_DISABLED - UPDATING_SINGLE_REGION_DATABASE_NOT_ALLOWED_WITH_ACTIVE_ACTIVE_SUBSCRIPTION - GETTING_ACTIVE_ACTIVE_SUBSCRIPTION_VPC_PEERINGS_IS_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - UPDATING_SINGLE_REGION_CIDR_WHITE_LIST_IS_NOT_ALLOWED_WITH_ACTIVE_ACTIVE_SUBSCRIPTION - GETTING_SINGLE_REGION_CIDR_WHITE_LIST_IS_NOT_ALLOWED_WITH_ACTIVE_ACTIVE_SUBSCRIPTION - ADDING_REGION_IS_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - DELETING_REGION_IS_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - SINGLE_REGION_SUBSCRIPTION_MUST_DEFINE_ONLY_ONE_REGION - CREATING_A_SINGLE_REGION_VPC_PEERING_IS_NOT_ALLOWED_WITH_ACTIVE_ACTIVE_SUBSCRIPTION - 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 - 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 - DELETING_FIXED_DATABASE_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - FIXED_DATABASE_MEMORY_LIMIT_IN_GB_AND_DATA_SET_SIZE_SUPPORTED_ONLY_FOR_PAY_AS_YOU_GO - FIXED_DATABASE_FIXED_SUBSCRIPTION_REACHED_MAX_DATABASES_COUNT - FIXED_DATABASE_SOURCE_IPS_LIST_IS_GREATER_THAN_PLAN_MAX_COUNT_ALLOWED_SOURCE_IPS - FIXED_DATABASE_ENABLE_DATABASE_CLUSTERING_SUPPORTED_ONLY_FOR_PAY_AS_YOU_GO - FIXED_DATABASE_ENABLE_DATABASE_CLUSTERING_WITH_REDIS_SEARCH_OR_GRAPH_MODULES_IS_NOT_ALLOWED - FIXED_DATABASE_PAYG_MEMORY_LIMIT_IN_GB_IS_MISSING - FIXED_DATABASE_PAYG_MEMORY_LIMIT_IN_GB_OR_DATA_SET_SIZE_IN_GB_IS_MISSING - FIXED_DATABASE_ALERT_NOT_SUPPORTED - PAY_AS_YOU_GO_DATABASE_ALERT_NOT_SUPPORTED - FIXED_DATABASE_REPLICA_OF_MEMCACHED_IS_NOT_SUPPORTED - FIXED_DATABASE_STACK_PROTOCOL_CONTAINS_MODULES - FIXED_DATABASE_STACK_PROTOCOL_IS_NOT_SUPPORTED_IN_SELECTED_PLAN_OR_CLUSTER - FIXED_DATABASE_REDIS_PROTOCOL_IS_NOT_SUPPORTED_IN_SELECTED_PLAN - FIXED_DATABASE_REPLICATION_IS_NOT_SUPPORTED_IN_REQUESTED_PLAN - FIXED_DATABASE_OSS_CLUSTER_API_IS_NOT_SUPPORTED_IN_REQUESTED_PLAN - FIXED_DATABASE_USE_EXTERNAL_ENDPOINT_FOR_OSS_CLUSTER_API_NOT_SUPPORTED_IN_REQUESTED_PLAN - FIXED_DATABASE_REGEX_RULES_NOT_SUPPORTED_IN_REQUESTED_PLAN - FIXED_DATABASE_ENABLE_TLS_NOT_SUPPORTED_IN_REQUESTED_PLAN - FIXED_DATABASE_CLIENT_SSL_CERTIFICATE_NOT_SUPPORTED_IN_REQUESTED_PLAN - FIXED_DATABASE_REPLICA_OF_NOT_SUPPORTED_IN_REQUESTED_PLAN - FIXED_DATABASE_CLUSTER_DOES_NOT_SUPPORT_DATA_PERSISTENCE - FIXED_DATABASE_NO_EVICTION_IS_NOT_SUPPORTED_BY_CLUSTER - FIXED_DATABASE_DATA_EVICTION_POLICY_IS_NOT_SUPPORTED_BY_CLUSTER - FIXED_DATABASE_DATA_EVICTION_POLICY_IS_NOT_SUPPORTED_BY_SELECTED_MODULES - FIXED_DATABASE_EVICTION_POLICY_NOT_COMPATIBLE_WITH_REDIS_VERSION - DATABASE_EVICTION_POLICY_NOT_COMPATIBLE_WITH_REDIS_VERSION - DATABASE_EVICTION_POLICY_NOT_COMPATIBLE_WITH_REDIS_FLEX - FIXED_DATABASE_EVICTION_POLICY_NOT_COMPATIBLE_WITH_REDIS_FLEX - FIXED_DATABASE_REPLICA_OF_IS_NOT_SUPPORTED_BY_SELECTED_MODULES - FIXED_DATABASE_DATA_PERSISTENCE_VALUE_NOT_SUPPORTED_FOR_FIXED - FIXED_DATABASE_DATA_EVICTION_POLICY_IS_NOT_SUPPORTED_BY_ALL_MODULES_IN_SELECTED_PLAN_OR_CLUSTER - FIXED_DATABASE_RESP_VERSION_IS_NOT_SUPPORTED - FIXED_DATABASE_REDIS_FLEX_IS_NOT_SUPPORTED - FIXED_DATABASE_STACK_PROTOCOL_IS_NOT_SUPPORTED_FOR_REDIS_FLEX - FIXED_DATABASE_MEMCACHED_PROTOCOL_IS_NOT_SUPPORTED_FOR_REDIS_FLEX - FIXED_DATABASE_MEMCACHED_PROTOCOL_IS_NOT_SUPPORTED_FOR_FREE_PLAN - FIXED_DATABASE_NUMBER_OF_SHARDS_IS_NOT_SUPPORTED_FOR_THIS_ACCOUNT - FIXED_DATABASE_NUMBER_OF_SHARDS_REQUIRES_DATABASE_CLUSTERING_ENABLED - FIXED_DATABASE_NUMBER_OF_SHARDS_INVALID_VALUE - PAYMENT_INFO_NOT_ALLOWED_WHEN_ACCOUNT_POC_ACTIVE - 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 - ACCOUNT_MARKETPLACE_NOT_FOUND - ACCOUNT_MARKETPLACE_NOT_SUPPORT_NON_HOSTED_ACCOUNTS - PAYMENT_INVALID_CARD_NUMBER - PAYMENT_INVALID_CCV - PAYMENT_INVALID_CARD_TYPE - PAYMENT_CVV_MISSING - PAYMENT_GENERAL_ERROR - PAYMENT_HOLD_FAILED - ACL_USER_NAME_ALREADY_EXISTS - ACL_USER_NAME_NOT_VALID - ACL_USER_NOT_FOUND - ACL_USER_NAME_IS_MISSING - ACL_ROLE_NAME_IS_MISSING - ACL_ROLE_REDIS_RULE_MUST_BE_DEFINED_ONLY_ONCE_PER_DATABASE - ACL_ROLE_REDIS_RULE_ALREADY_EXISTS_FOR_REQUESTED_RESOURCE - ACL_ROLE_REDIS_RULES_IS_MISSING - ACL_ROLE_REDIS_RULES_DATABASES_SPEC_IS_MISSING - ACL_ROLE_REDIS_RULES_DATABASES_DATABASE_ID_IS_MISSING - ACL_ROLE_REDIS_RULES_DATABASES_SUBSCRIPTION_ID_IS_MISSING - ACL_ROLE_REDIS_RULES_DATABASES_REGIONS_IS_MISSING - ACL_ROLE_REDIS_RULES_DATABASES_REGION_MUST_BE_CRDB - ACL_ROLE_REDIS_RULES_DATABASES_REGION_NOT_IN_PLAN - ACL_ROLE_REDIS_RULES_DATABASES_REGION_NOT_UNIQUE - ACL_ROLE_REDIS_RULES_DATABASES_REGION_IS_NOT_BELONGS_TO_DATABASE - ACL_ROLE_NAME_NOT_VALID - ACL_ROLE_DOES_NOT_EXISTS - ACL_USER_PASSWORD_NOT_VALID - ACL_USER_PASSWORD_IS_MISSING - ACL_USER_CREATION_FAILURE - ACL_REDIS_RULE_NAME_IS_MISSING - ACL_REDIS_RULE_NAME_ALREADY_EXISTS - ACL_REDIS_RULE_NAME_NOT_VALID - ACL_REDIS_RULE_NAME_NOT_IN_RANGE - ACL_REDIS_RULE_PATTERN_IS_MISSING - ACL_REDIS_RULE_PATTERN_NOT_VALID - ACL_REDIS_RULE_INVALID_PUBSUB_PATTERN - ACL_REDIS_RULE_ACCOUNT_NOT_SUPPORT_PUBSUB_PATTERN - ACL_REDIS_RULE_ALLCHANNELS_BEFORE_SPECIFIC_CHANNEL - ACL_REDIS_RULE_INVALID_CATEGORY_RULE_PATTERN - ACL_REDIS_RULE_INVALID_KEYSPACE_RULE_PATTERN - ACL_REDIS_RULE_INVALID_COMMAND_OR_MODULE_COMMAND_RULE_PATTERN - ACL_REDIS_RULE_ALLKEYS_BEFORE_SPECIFIC_KEY - ACL_REDIS_RULE_CREATION_FAILURE - ACL_REDIS_RULE_NOT_FOUND - ACL_REDIS_RULE_CANNOT_UPDATE_DEFAULT - ACL_REDIS_RULE_CANNOT_DELETE_DEFAULT - ACL_REDIS_RULE_CANNOT_DELETE_WHEN_ASSOCIATED_WITH_ROLES - ACL_REDIS_RULE_NOT_ACTIVE - ACL_GENERAL_ERROR - ACL_ROLE_NAME_ALREADY_EXISTS - ACL_ROLE_HAS_ACTIVE_USERS_AND_CANNOT_BE_DELETED - ACL_ROLE_IS_IN_PENDING_STATUS_AND_CANNOT_BE_DELETED - ACL_ROLE_IS_IN_PENDING_STATUS_AND_CANNOT_BE_UPDATED - ACL_ROLE_NOT_FOUND - ACL_ROLE_ID_IS_MISSING - ACL_REDIS_RULE_DOES_NOT_EXISTS - ACL_REDIS_RULE_INVALID_KEY_PERMISSION_PATTERN - ACL_REDIS_RULE_INVALID_SELECTORS_PATTERN - BDB_IS_NOT_IN_CORRECT_VERSION_FOR_GIVEN_ACL_VERSION - USER_NOT_FOUND - USER_INSUFFICIENT_ROLE - USER_NAME_IS_INVALID - USER_CANNOT_UPDATE_IT_IS_OWN_ROLE - USER_WITHOUT_OWNER_PERMISSION_CANNOT_UPDATE_USERS - USER_WITHOUT_OWNER_PERMISSION_CANNOT_PERFORM_ACTIONS_ON_USERS - USER_CANNOT_BE_UPDATED_OR_DELETED_BEFORE_VERIFICATION - USER_ROLE_DOES_NOT_EXISTS - USER_ROLE_IS_MISSING - USER_CANNOT_DELETE_OWN_USER - ENTITY_NOT_FOUND - FIXED_SUBSCRIPTION_CREATE_PLAN_NOT_FOUND - FIXED_SUBSCRIPTION_UPDATE_INVALID_PLAN - FIXED_SUBSCRIPTION_PLAN_NOT_PROVIDED - FIXED_SUBSCRIPTION_ACCOUNT_ALREADY_HAS_A_FREE_PLAN - FIXED_MISMATCH_BETWEEN_REQUEST_PLAN_CLOUD_PROVIDER_AND_SUBSCRIPTION_CLOUD_PROVIDER - FIXED_MISMATCH_BETWEEN_REQUEST_PLAN_REGION_AND_SUBSCRIPTION_REGION - FIXED_SUBSCRIPTION_PLAN_MAX_DATABASES_SMALLER_THEN_CURRENT_SUBSCRIPTION_DATABASES_COUNT - FIXED_SUBSCRIPTION_PLAN_SIZE_SMALLER_THEN_CURRENT_SUBSCRIPTION_USAGE - FIXED_SUBSCRIPTION_PLAN_NOT_SUPPORT_REPLICA_OF - FIXED_SUBSCRIPTION_PLAN_DATABASES_ARE_RESTRICTED_TO_A_SINGLE_CLUSTER - FIXED_SUBSCRIPTION_PLAN_NOT_SUPPORT_TLS - FIXED_SUBSCRIPTION_PLAN_CANNOT_CHANGED_FROM_AVAILABILITY_OF_SINGLE_ZONE_OR_NO_REPLICATION_TO_MULTI_ZONE - FIXED_SUBSCRIPTION_PLAN_CANNOT_CHANGED_FROM_AVAILABILITY_OF_MULTI_ZONE_TO_SINGLE_ZONE_OR_NO_REPLICATION - FIXED_SUBSCRIPTION_PLAN_MAX_SOURCE_IPS_IS_SMALLER_THEN_ONE_OF_EXISTING_DATABSE_SOURCE_IPS - FIXED_SUBSCRIPTION_INVALID_NAME - FIXED_SUBSCRIPTION_NAME_NOT_PROVIDED - REDIS_FLEX_PLAN_CANNOT_BE_UPDATED_TO_NON_REDIS_FLEX - NON_REDIS_FLEX_PLAN_CANNOT_BE_UPDATED_TO_REDIS_FLEX_PLAN - DELETING_A_FIXED_SUBSCRIPTION_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - UPDATING_A_FIXED_SUBSCRIPTION_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - UPDATING_A_FIXED_SUBSCRIPTION_PLAN_IS_NOT_ALLOWED_WHILE_THE_SUBSCRIPTION_OR_BDB_IS_PENDING - FIXED_PAYMENT_INFO_NOT_ALLOWED_IN_FREE_FIXED_PLAN - FREE_PLAN_IS_ALLOWED_ONLY_FOR_ACCOUNTS_WITH_VALID_PAYMENT_INFO - BACKUP_A_FIXED_DATABASE_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - IMPORT_A_FIXED_DATABASE_IS_NOT_ALLOWED_WITH_A_FLEXIBLE_SUBSCRIPTION - TOO_MANY_PENDING_SUBSCRIPTIONS - BAD_REQUEST - GENERAL_ERROR - CONFLICT_ERROR - UNKNOWN_STATUS - CRDB_FLUSH_FAILURE - CRDB_FLUSH_ACTION_NOT_ALLOWED_WITH_SINGLE_REGION_SUBSCRIPTION - 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 - MAINTENANCE_WINDOW_AUTOMATIC_MODE_WITH_MAINTENANCE_WINDOWS - MAINTENANCE_WINDOW_GREATER_THAN_MAXIMUM_ALLOWABLE_MAINTENANCE_WINDOWS_PROVIDED - MAINTENANCE_WINDOW_INVALID_START_HOUR - MAINTENANCE_WINDOW_INVALID_DURATION_IN_HOURS - MAINTENANCE_WINDOW_INVALID_DAYS - MAINTENANCE_WINDOW_DUPLICATE_DAYS - MAINTENANCE_WINDOW_INVALID_DURATION_FOR_ROF_SUBSCRIPTION - MAINTENANCE_WINDOW_UNKNOWN_MEMORY_STORAGE_TYPE - DATABASE_UPGRADE_IS_ALREADY_RUNNING - DATABASE_CLUSTER_IS_IN_MAINTENANCE - DATABASE_IS_NOT_ACTIVE - DATABASE_UPGRADE_WORKFLOW_NOT_FOUND - DATABASE_UPGRADE_INVALID_REDIS_VERSION - DATABASE_UPGRADE_OF_MEMCACHED_IS_NOT_SUPPORTED - DATABASE_REPLICA_OF_INCOMPATIBLE_VERSION - DATABASE_UPGRADE_FAILED - DATABASE_INVALID_PLAN_TYPE - 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 - DB_ENDPOINTS_SERVICE_NOT_FOUND - ENDPOINTS_REDIRECTION_NOT_FOUND - DATABASE_TRAFFIC_STATE_NOT_FOUND - ENDPOINTS_REDIRECTION_SOURCE_HAS_NO_ENDPOINTS - ENDPOINTS_REDIRECTION_TARGET_HAS_NO_ENDPOINTS - ENDPOINTS_REDIRECTION_ALREADY_EXISTS - DATABASE_IN_ACTIVE_ENDPOINTS_REDIRECTION - ENDPOINTS_REDIRECTION_NOT_LATEST - ENDPOINTS_REDIRECTION_NOT_COMPLETED - ENDPOINTS_REDIRECTION_INVALID_ENDPOINT_TYPE - ENDPOINTS_REDIRECTION_DATABASES_NOT_COMPATIBLE - ENDPOINTS_REDIRECTION_DATABASE_STATE_NOT_SUPPORTED - ENDPOINTS_REDIRECTION_CONNECTIVITY_MISMATCH - ENDPOINTS_REDIRECTION_REVERT_WINDOW_EXCEEDED - ENDPOINTS_REDIRECTION_ACCOUNT_MISMATCH - ENDPOINTS_REDIRECTION_DNS_SERVICE_NOT_AVAILABLE - DATABASE_TRAFFIC_RESUME_IN_PROGRESS - DATABASE_TRAFFIC_NOT_STOPPED - DATABASE_TRAFFIC_RESUME_NOT_ELIGIBLE - DEDICATED_SUBSCRIPTION_PREFERRED_AZ_INVALID_VALUE - DEDICATED_SUBSCRIPTION_INVALID_INSTANCE_NAME - 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_PRINCIPAL_CANNOT_BE_OWNER_ACCOUNT - 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_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_SUBSCRIPTION_REACHED_MAX_DATABASES_COUNT - PRIVATE_LINK_ALL_PRINCIPALS_MUST_BE_DELETED_BEFORE_DELETING_RESOURCE_LINK - PRIVATE_LINK_DISASSOCIATE_CONNECTIONS_A_FLEXIBLE_SUBSCRIPTION_PRIVATE_LINK_IS_NOT_ALLOWED_WITH_AN_ACTIVE_ACTIVE_SUBSCRIPTION - PRIVATE_LINK_DISASSOCIATE_CONNECTIONS_AN_ACTIVE_ACTIVE_SUBSCRIPTION_PRIVATE_LINK_IS_NOT_ALLOWED_WITH_A_SINGLE_REGION_SUBSCRIPTION - 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 - COST_REPORT_FUTURE_DATES_NOT_ALLOWED - AGENT_MEMORY_IS_DISABLED - AGENT_MEMORY_STORE_INVALID_REQUEST - AGENT_MEMORY_STORE_NOT_FOUND - AGENT_MEMORY_STORE_FORBIDDEN - AGENT_MEMORY_STORE_DEPENDENCY_FAILED additionalInfo: type: string DynamicEndpoints: type: object properties: public: type: string description: Public dynamic endpoint of the database. This is available in private preview. example: accessible-wise-produce-60121.db-qa.redis.io:13427 private: type: string description: Private dynamic endpoint of the database. This is available in private preview. example: effective-ticket-plants-62093.db-qa.redis.io:13427 description: Database dynamic endpoints. This is available in private preview. FixedDatabaseImportRequest: required: - importFromUri - sourceType type: object properties: subscriptionId: type: integer format: int32 readOnly: true databaseId: type: integer format: int32 readOnly: true sourceType: type: string description: Type of storage from which to import the database RDB file or Redis data. example: http enum: - http - redis - ftp - aws-s3 - azure-blob-storage - google-blob-storage importFromUri: type: array description: One or more paths to source data files or Redis databases, as appropriate to specified source type. items: type: string description: One or more paths to source data files or Redis databases, as appropriate to specified source type. commandType: type: string readOnly: true description: Database import request AccountFixedSubscriptionDatabases: type: object properties: accountId: type: integer format: int32 links: type: array items: type: object additionalProperties: type: string description: RedisLabs Account Subscription Databases information example: accountId: 40131 subscription: subscriptionId: 154714 numberOfDatabases: 2 databases: - databaseId: 51324587 name: bdb protocol: stack provider: AWS region: us-east-1 redisVersion: '7.4' status: draft planMemoryLimit: 250 respVersion: resp2 memoryLimitMeasurementUnit: MB memoryUsedInMb: 1 memoryStorage: ram dataPersistence: none replication: true dataEvictionPolicy: noeviction dynamicEndpoints: public: beautiful-ultralight-board-76526.db-qa.redis.io:12345 private: dog-ball-key-65499.db-qa.redis.io:12345 clustering: enabled: false regexRules: - ordinal: 0 pattern: .*\{(?.*)\}.* - ordinal: 1 pattern: (?.*) hashingPolicy: standard security: defaultUserEnabled: true sourceIps: - 0.0.0.0/0 modules: - id: 18534 name: searchlight capabilityName: Search and query version: 2.2.6 description: A comprehensive, expressive, flexible, fast and developer-friendly search and query engine for the diversity of data types in Redis with state-of-the-art scoring algorithms parameters: [] - id: 18535 name: RedisBloom capabilityName: Probabilistic version: 2.2.12 description: A set of probabilistic data structures to Redis, including Bloom filter, Cuckoo filter, Count-min sketch, Top-K, and t-digest parameters: [] - id: 18536 name: RedisJSON capabilityName: JSON version: 2.0.6 description: Native JSON Data Type for Redis, allowing for atomic reads and writes of sub-elements parameters: [] - id: 18537 name: RedisTimeSeries capabilityName: Time series version: 1.6.8 description: Time-Series data structure for Redis parameters: [] alerts: - name: connections-limit value: 80 defaultValue: 80 backup: remoteBackupEnabled: false links: [] - databaseId: 51324586 name: firstDB protocol: stack provider: AWS region: us-east-1 status: draft planMemoryLimit: 250 memoryLimitMeasurementUnit: MB memoryUsedInMb: 1 memoryStorage: ram dataPersistence: none replication: true dataEvictionPolicy: noeviction dynamicEndpoints: public: morning-easy-volleyball-28510.db-qa.redis.io:12000 private: table-peanut-chin-89928.db-qa.redis.io:12000 clustering: enabled: false regexRules: - ordinal: 0 pattern: .*\{(?.*)\}.* - ordinal: 1 pattern: (?.*) hashingPolicy: standard security: defaultUserEnabled: true sourceIps: - 0.0.0.0/0 modules: - id: 18529 name: searchlight capabilityName: Search and query version: 2.2.6 description: A comprehensive, expressive, flexible, fast and developer-friendly search and query engine for the diversity of data types in Redis with state-of-the-art scoring algorithms parameters: [] - id: 18530 name: RedisBloom capabilityName: Probabilistic version: 2.2.12 description: A set of probabilistic data structures to Redis, including Bloom filter, Cuckoo filter, Count-min sketch, Top-K, and t-digest parameters: [] - id: 18531 name: RedisJSON capabilityName: JSON version: 2.0.6 description: Native JSON Data Type for Redis, allowing for atomic reads and writes of sub-elements parameters: [] - id: 18532 name: RedisTimeSeries capabilityName: Time series version: 1.6.8 description: Time-Series data structure for Redis parameters: [] alerts: - name: connections-limit value: 80 defaultValue: 80 backup: remoteBackupEnabled: false links: [] links: [] links: [] FixedDatabaseUpdateRequest: type: object properties: subscriptionId: type: integer format: int32 readOnly: true databaseId: type: integer format: int32 readOnly: true name: type: string description: Optional. Updated database name. example: Redis-Essentials-database-example memoryLimitInGb: minimum: 0.1 type: number description: (Pay-as-you-go subscriptions only) Optional. Total memory in GB, including replication and other overhead. You cannot set both datasetSizeInGb and totalMemoryInGb. format: double example: 1 deprecated: true datasetSizeInGb: minimum: 0.1 type: number description: (Pay-as-you-go subscriptions only) Optional. The maximum amount of data in the dataset for this database in GB. You cannot set both datasetSizeInGb and totalMemoryInGb. If ‘replication’ is 'true', the database’s total memory will be twice as large as the datasetSizeInGb. If ‘replication’ is false, the database’s total memory will be the datasetSizeInGb value. format: double example: 1 supportOSSClusterApi: type: boolean 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). example: true respVersion: type: string description: Optional. Redis Serialization Protocol version. Must be compatible with Redis version. example: resp3 enum: - resp2 - resp3 useExternalEndpointForOSSClusterApi: type: boolean description: '(Pay-as-you-go subscriptions only) Optional. If set to ''true'', the database will use the external endpoint for OSS Cluster API. This setting blocks the database''s private endpoint. Can only be set if ''supportOSSClusterAPI'' is ''true''. Default: ''false''' example: true enableDatabaseClustering: type: boolean description: (Pay-as-you-go subscriptions only) Optional. Distributes database data to different cloud instances. example: false numberOfShards: type: integer description: (Pay-as-you-go subscriptions only) Optional. Changes the number of master shards. format: int32 example: 2 dataPersistence: type: string description: Optional. Type and rate of data persistence in persistent storage. Use GET /fixed/plans/{planId} to see if your plan supports data persistence. enum: - none - aof-every-1-second - aof-every-write - snapshot-every-1-hour - snapshot-every-6-hours - snapshot-every-12-hours dataEvictionPolicy: type: string description: Optional. Turns database replication on or off. enum: - allkeys-lru - allkeys-lfu - allkeys-lrm - allkeys-random - volatile-lru - volatile-lfu - volatile-lrm - volatile-random - volatile-ttl - noeviction replication: type: boolean description: Optional. Sets database replication. Use GET /fixed/plans/{planId} to see if your plan supports database replication. periodicBackupPath: type: string description: Optional. Changes the backup location path. If specified, the database will back up every 24 hours to this location, and you can manually back up the database to this location at any time. Use GET /fixed/plans/{planId} to see if your plan supports database backups. If set to an empty string, the backup path will be removed. example: s3:// sourceIps: type: array description: 'Optional. List of source IP addresses or subnet masks to allow. If specified, 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'']''' items: type: string description: 'Optional. List of source IP addresses or subnet masks to allow. If specified, 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'']''' replicaOf: type: array description: 'Optional. This database will be a replica of the specified Redis databases provided as one or more URI (sample format: ''redis://user:password@host:port)''. If the URI provided is Redis Cloud instance, only host and port should be provided (using the format: [''redis://endpoint1:6379'', ''redis://endpoint2:6380''] ).' deprecated: true items: type: string description: 'Optional. This database will be a replica of the specified Redis databases provided as one or more URI (sample format: ''redis://user:password@host:port)''. If the URI provided is Redis Cloud instance, only host and port should be provided (using the format: [''redis://endpoint1:6379'', ''redis://endpoint2:6380''] ).' replica: $ref: '#/components/schemas/ReplicaOfSpec' regexRules: type: array description: (Pay-as-you-go subscriptions only) Optional. Hashing policy Regex rules. Used only if 'shardingType' is 'custom-regex-rules'. items: type: string description: (Pay-as-you-go subscriptions only) Optional. Hashing policy Regex rules. Used only if 'shardingType' is 'custom-regex-rules'. clientSslCertificate: type: string description: Optional. A public key client TLS/SSL certificate with new line characters replaced with '\n'. If specified, mTLS authentication will be required to authenticate user connections if it is not already required. If set to an empty string, TLS client certificates will be removed and mTLS will not be required. TLS connection may still apply, depending on the value of 'enableTls'. deprecated: true clientTlsCertificates: type: array description: Optional. A list of client TLS/SSL certificates. If specified, mTLS authentication will be required to authenticate user connections. If set to an empty list, TLS client certificates will be removed and mTLS will not be required. TLS connection may still apply, depending on the value of 'enableTls'. items: $ref: '#/components/schemas/DatabaseCertificateSpec' enableTls: type: boolean description: Optional. When 'true', requires TLS authentication for all connections - mTLS with valid clientTlsCertificates, regular TLS when clientTlsCertificates is not provided. If enableTls is set to 'false' while mTLS is required, it will remove the mTLS requirement and erase previously provided clientTlsCertificates. password: type: string description: Optional. Changes the password used to access the database with the 'default' user. 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. alerts: type: array description: Optional. Changes Redis database alert details. items: $ref: '#/components/schemas/DatabaseAlertSpec' commandType: type: string readOnly: true description: Essentials database update request DatabaseTagUpdateRequest: required: - value type: object properties: subscriptionId: type: integer format: int32 readOnly: true databaseId: type: integer format: int32 readOnly: true key: type: string readOnly: true value: type: string description: Database tag value commandType: type: string readOnly: true description: Database tag update request message TargetVersion: type: object properties: redisVersion: type: string CloudTag: type: object properties: links: type: array items: type: object additionalProperties: type: string key: type: string value: type: string createdAt: type: string updatedAt: type: string description: Database tag example: key: environment value: production createdAt: '2024-05-21T20:02:21+02:00' updatedAt: '2024-06-21T20:02:21+02:00' links: - rel: self type: GET href: http://localhost:8081/v1/fixed/subscriptions/178867/databases/51412930/tags DatabaseVersionUpgradeStatus: type: object properties: databaseId: type: integer format: int32 targetRedisVersion: type: string progress: type: number format: double upgradeStatus: type: string enum: - in-progress - in-progress-recovery-pending - done - failed FixedDatabase: type: object properties: databaseId: type: integer format: int32 name: type: string protocol: type: string enum: - redis - memcached - stack provider: type: string region: type: string redisVersion: type: string redisVersionCompliance: type: string deprecated: true respVersion: type: string enum: - resp2 - resp3 status: type: string planMemoryLimit: type: number format: double planDatasetSize: type: number format: double memoryLimitMeasurementUnit: type: string memoryLimitInGb: type: number format: double datasetSizeInGb: type: number format: double memoryUsedInMb: type: number format: double networkMonthlyUsageInByte: type: number format: double memoryStorage: type: string enum: - ram - ram-and-flash redisFlex: type: boolean supportOSSClusterApi: type: boolean useExternalEndpointForOSSClusterApi: type: boolean dataPersistence: type: string enum: - none - aof-every-1-second - aof-every-write - snapshot-every-1-hour - snapshot-every-6-hours - snapshot-every-12-hours replication: type: boolean dataEvictionPolicy: type: string enum: - allkeys-lru - allkeys-lfu - allkeys-lrm - allkeys-random - volatile-lru - volatile-lfu - volatile-lrm - volatile-random - volatile-ttl - noeviction activatedOn: type: string format: date-time lastModified: type: string format: date-time publicEndpoint: type: string privateEndpoint: type: string dynamicEndpoints: $ref: '#/components/schemas/DynamicEndpoints' replicaAsSourceEndpoints: $ref: '#/components/schemas/ReplicaAsSourceEndpoints' links: type: array items: type: object additionalProperties: type: string example: databaseId: 51324587 name: bdb protocol: stack provider: AWS region: us-east-1 status: draft planMemoryLimit: 250 respVersion: resp2 memoryLimitMeasurementUnit: MB memoryUsedInMb: 7 memoryStorage: ram dataPersistence: none replication: true dataEvictionPolicy: noeviction dynamicEndpoints: public: hyperclear-comparison-purpose-36067.db-qa.redis.io:12037 private: mahogany-refined-system-53022.db-qa.redis.io:12037 clustering: enabled: false regexRules: - ordinal: 0 pattern: .*\{(?.*)\}.* - ordinal: 1 pattern: (?.*) hashingPolicy: standard security: defaultUserEnabled: true password: myCustomPassword sourceIps: - 0.0.0.0/0 modules: - id: 18534 name: RediSearch capabilityName: Search and query version: 2.2.6 description: A comprehensive, expressive, flexible, fast and developer-friendly search and query engine for the diversity of data types in Redis with state-of-the-art scoring algorithms parameters: [] - id: 18535 name: RedisBloom capabilityName: Probabilistic version: 2.2.12 description: A set of probabilistic data structures to Redis, including Bloom filter, Cuckoo filter, Count-min sketch, Top-K, and t-digest parameters: [] - id: 18536 name: RedisJSON capabilityName: JSON version: 2.0.6 description: Native JSON Data Type for Redis, allowing for atomic reads and writes of sub-elements parameters: [] - id: 18537 name: RedisTimeSeries capabilityName: Time series version: 1.6.8 description: Time-Series data structure for Redis parameters: [] alerts: - name: connections-limit value: 80 defaultValue: 80 backup: remoteBackupEnabled: false links: [] DatabaseSyncSourceSpec: required: - endpoint type: object properties: endpoint: type: string description: 'Redis URI of a source database. Example format: ''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''.' encryption: type: boolean description: Defines if encryption should be used to connect to the sync source. If not set the source is a Redis Cloud database, it will automatically detect if the source uses encryption. serverCert: type: string description: TLS/SSL certificate chain of the sync source. If not set and the source is a Redis Cloud database, it will automatically detect the certificate to use. description: Optional. This database will be a replica of the specified Redis databases, provided as a list of objects with endpoint and certificate details. ReplicaOfSpec: required: - syncSources type: object properties: syncSources: type: array description: Optional. This database will be a replica of the specified Redis databases, provided as a list of objects with endpoint and certificate details. items: $ref: '#/components/schemas/DatabaseSyncSourceSpec' description: Optional. Changes Replica Of (also known as Active-Passive) configuration details. DatabaseSlowLogEntries: type: object properties: entries: type: array items: $ref: '#/components/schemas/DatabaseSlowLogEntry' links: type: array items: type: object additionalProperties: type: string TaskStateUpdate: type: object properties: taskId: type: string format: uuid commandType: type: string status: type: string enum: - initialized - received - processing-in-progress - processing-completed - processing-error description: type: string timestamp: type: string format: date-time response: $ref: '#/components/schemas/ProcessorResponse' links: type: array items: type: object additionalProperties: type: string FixedDatabaseBackupRequest: type: object properties: subscriptionId: type: integer format: int32 readOnly: true databaseId: type: integer format: int32 readOnly: true adhocBackupPath: type: string description: Optional. Manually backs up data to this location, instead of the set 'periodicBackupPath' location. example: s3:// commandType: type: string readOnly: true description: Essentials database backup request message DatabaseModuleSpec: required: - name type: object properties: name: type: string description: Redis advanced capability name. Use GET /database-modules for a list of available capabilities. parameters: type: object additionalProperties: type: object description: Optional. Redis advanced capability parameters. Use GET /database-modules to get the available capabilities and their parameters. example: {} description: Optional. Redis advanced capability parameters. Use GET /database-modules to get the available capabilities and their parameters. 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. Don't specify modules for database versions 8 and above. All capabilities are bundled in the database by default. FixedDatabaseCreateRequest: required: - name type: object properties: subscriptionId: type: integer format: int32 readOnly: true 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-Essentials-database-example protocol: type: string description: 'Optional. Database protocol. Use ''stack'' to get all of Redis'' advanced capabilities. Only use ''redis'' for Pay-as-you-go or Redis Flex subscriptions. Default: ''stack'' for most subscriptions, ''redis'' for Redis Flex subscriptions.' enum: - redis - memcached - stack memoryLimitInGb: minimum: 0.1 type: number description: (Pay-as-you-go subscriptions only) Optional. Total memory in GB, including replication and other overhead. You cannot set both datasetSizeInGb and totalMemoryInGb. format: double example: 1 deprecated: true datasetSizeInGb: minimum: 0.1 type: number description: (Pay-as-you-go subscriptions only) Optional. The maximum amount of data in the dataset for this database in GB. You cannot set both datasetSizeInGb and totalMemoryInGb. If ‘replication’ is 'true', the database’s total memory will be twice as large as the datasetSizeInGb. If ‘replication’ is false, the database’s total memory will be the datasetSizeInGb value. format: double example: 1 supportOSSClusterApi: type: boolean 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. example: resp3 enum: - resp2 - resp3 useExternalEndpointForOSSClusterApi: type: boolean description: '(Pay-as-you-go subscriptions only) Optional. If set to ''true'', the database will use the external endpoint for OSS Cluster API. This setting blocks the database''s private endpoint. Can only be set if ''supportOSSClusterAPI'' is ''true''. Default: ''false''' example: true enableDatabaseClustering: type: boolean description: '(Pay-as-you-go subscriptions only) Optional. Distributes database data to different cloud instances. Default: ''false''' example: false numberOfShards: type: integer description: (Pay-as-you-go subscriptions only) Optional. Specifies the number of master shards. format: int32 example: 2 dataPersistence: type: string description: Optional. Type and rate of data persistence in persistent storage. Use GET /fixed/plans/{planId} to see if your plan supports data persistence. enum: - none - aof-every-1-second - aof-every-write - snapshot-every-1-hour - snapshot-every-6-hours - snapshot-every-12-hours dataEvictionPolicy: type: string description: Optional. Data eviction policy. enum: - allkeys-lru - allkeys-lfu - allkeys-lrm - allkeys-random - volatile-lru - volatile-lfu - volatile-lrm - volatile-random - volatile-ttl - noeviction replication: type: boolean description: Optional. Sets database replication. Use GET /fixed/plans/{planId} to see if your plan supports database replication. periodicBackupPath: type: string description: Optional. The path to a backup storage location. If specified, the database will back up every 24 hours to this location, and you can manually back up the database to this location at any time. Use GET /fixed/plans/{planId} to see if your plan supports database backups. example: s3:// sourceIps: type: array description: 'Optional. List of source IP addresses or subnet masks to allow. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. Use GET /fixed/plans/{planId} to see how many CIDR allow rules your plan supports. Example: ''[''192.168.10.0/32'', ''192.168.12.0/24'']''' items: type: string description: 'Optional. List of source IP addresses or subnet masks to allow. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. Use GET /fixed/plans/{planId} to see how many CIDR allow rules your plan supports. Example: ''[''192.168.10.0/32'', ''192.168.12.0/24'']''' regexRules: type: array description: (Pay-as-you-go subscriptions only) Optional. Hashing policy Regex rules. Used only if 'enableDatabaseClustering' is set to 'true' and . items: type: string description: (Pay-as-you-go subscriptions only) Optional. Hashing policy Regex rules. Used only if 'enableDatabaseClustering' is set to 'true' and . 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''].' deprecated: true items: type: string 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''].' replica: $ref: '#/components/schemas/ReplicaOfSpec' clientSslCertificate: type: string description: 'Optional. A public key client TLS/SSL certificate with new line characters replaced with ''\n''. If specified, mTLS authentication will be required to authenticate user connections. Default: ''null''' deprecated: true clientTlsCertificates: type: array description: Optional. A list of client TLS/SSL certificates. If specified, mTLS authentication will be required to authenticate user connections. items: $ref: '#/components/schemas/DatabaseCertificateSpec' enableTls: type: boolean description: 'Optional. When ''true'', requires TLS authentication for all connections - mTLS with valid clientTlsCertificates, regular TLS when clientTlsCertificates is not provided. Default: ''false''' password: type: string description: Optional. Password to access the database. If not set, a random 32-character alphanumeric password will be automatically generated. alerts: type: array description: Optional. Redis database alert details. items: $ref: '#/components/schemas/DatabaseAlertSpec' 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'. Don't specify modules for database versions 8 and above. All capabilities are bundled in the database by default. items: $ref: '#/components/schemas/DatabaseModuleSpec' commandType: type: string readOnly: true description: Essentials database definition DatabaseCertificateSpec: required: - publicCertificatePEMString type: object properties: publicCertificatePEMString: type: string description: Client certificate public key in PEM format, with new line characters replaced with '\n'. description: Optional. A list of client TLS/SSL certificates. If specified, mTLS authentication will be required to authenticate user connections. If set to an empty list, TLS client certificates will be removed and mTLS will not be required. TLS connection may still apply, depending on the value of 'enableTls'. DatabaseTagCreateRequest: required: - key - value type: object properties: key: type: string description: Database tag key. example: environment value: type: string description: Database tag value. example: production subscriptionId: type: integer format: int32 readOnly: true databaseId: type: integer format: int32 readOnly: true commandType: type: string readOnly: true description: Database tag DatabaseAvailableVersionsResponse: type: object properties: targets: type: array items: $ref: '#/components/schemas/TargetVersion' tag: required: - key - value type: object properties: key: type: string description: Database tag key. example: environment value: type: string description: Database tag value. example: production commandType: type: string readOnly: true description: Database tag DatabaseTrafficStateResponse: type: object properties: bdbId: type: integer format: int32 trafficStatus: type: string canResume: type: boolean resumeInProgress: type: boolean stopReason: type: string resumeEligibleAt: type: string format: date-time DatabaseTagsUpdateRequest: required: - tags type: object properties: subscriptionId: type: integer format: int32 readOnly: true databaseId: type: integer format: int32 readOnly: true tags: type: array description: List of database tags. items: $ref: '#/components/schemas/tag' commandType: type: string readOnly: true description: Database tags update request message DatabaseAlertSpec: required: - name - value type: object properties: name: type: string description: Alert type. Available options depend on Plan type. See [Configure alerts](https://redis.io/docs/latest/operate/rc/databases/monitor-performance/#configure-metric-alerts) for more information. example: dataset-size enum: - dataset-size - datasets-size - throughput-higher-than - throughput-lower-than - latency - syncsource-error - syncsource-lag - connections-limit value: type: integer description: Value over which an alert will be sent. Default values and range depend on the alert type. See [Configure alerts](https://redis.io/docs/latest/operate/rc/databases/monitor-performance/#configure-metric-alerts) for more information. format: int32 example: 80 description: Optional. Changes Redis database alert details. 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. securitySchemes: x-api-key: type: apiKey name: x-api-key in: header x-api-secret-key: type: apiKey name: x-api-secret-key in: header x-auth-token: type: apiKey name: x-auth-token in: header externalDocs: description: Redis Cloud API Documentation url: https://docs.redislabs.com/latest/rc/api/