@itentialopensource/adapter-redis_cloud/report/adapter-openapi.json

This adapter integrates with system described as: redisCloud.

{
"openapi": "3.0.1",
"info": {
"title": "Redis Cloud API",
"description": "Redis Cloud API",
"contact": {
"name": "Customer Support",
"url": "https://support.redislabs.com",
"email": "support@redis.com"
},
"version": "Version 1"
},
"servers": [
{
"url": "https://api.redislabs.com/v1"
}
],
"security": [
{
"x-api-key": []
},
{
"x-api-secret-key": []
}
],
"tags": [
{
"name": "Account",
"description": "Current account and ownership information",
"x-order": "0"
},
{
"name": "Subscriptions - Flexible",
"description": "All operations related to flexible subscriptions lifecycle",
"x-order": "1"
},
{
"name": "Databases - Flexible",
"description": "All operations related to flexible databases lifecycle",
"x-order": "2"
},
{
"name": "Subscriptions - Fixed",
"description": "All operations related to fixed subscriptions lifecycle",
"x-order": "3"
},
{
"name": "Databases - Fixed",
"description": "All operations related to fixed databases lifecycle",
"x-order": "4"
},
{
"name": "Access Control List",
"description": "Data and operations related to access control list",
"x-order": "5"
},
{
"name": "Cloud Accounts",
"description": "All operations related to cloud accounts (AWS only)",
"x-order": "6"
},
{
"name": "Users",
"description": "Data and operations related to account's users",
"x-order": "7"
},
{
"name": "Tasks",
"description": "Displays information on long running operations",
"x-order": "8"
}
],
"paths": {
"/users/{userId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get user by id",
"description": "Information on user identified by user Id",
"operationId": "getUserById",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUser"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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": [
"Users"
],
"summary": "Update user",
"description": "Update an existing user by Id",
"operationId": "updateUser",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUserUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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": [
"Users"
],
"summary": "Delete user",
"description": "Delete a user from current account",
"operationId": "deleteUserById",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 "
}
}
}
},
"/subscriptions/{subscriptionId}": {
"get": {
"tags": [
"Subscriptions - Flexible"
],
"summary": "Get subscription by id",
"description": "Information on subscription identified by subscription Id",
"operationId": "getSubscriptionById",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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": [
"Subscriptions - Flexible"
],
"summary": "Update subscription",
"description": "Update an existing subscription by Id",
"operationId": "updateSubscription",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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": [
"Subscriptions - Flexible"
],
"summary": "Delete subscription",
"description": "Delete a subscription identified by subscription Id (subscription must be empty, i.e. cannot contain databases)",
"operationId": "deleteSubscriptionById",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 "
}
}
}
},
"/subscriptions/{subscriptionId}/regions/peerings/{peeringId}": {
"put": {
"tags": [
"Subscriptions - Flexible"
],
"summary": "Update an active-active subscription VPC peering",
"description": "Update an existing VPC peering in an existing active-active subscription.",
"operationId": "updateActiveActiveVpcPeering",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "peeringId",
"in": "path",
"description": "VpcPeering Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActiveActiveVpcPeeringUpdateAwsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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": [
"Subscriptions - Flexible"
],
"summary": "Delete an active-active subscription VPC peering",
"description": "Delete a VPC peering from an existing active-active subscription.",
"operationId": "deleteActiveActiveVpcPeering",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "peeringId",
"in": "path",
"description": "VpcPeering Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 "
}
}
}
},
"/subscriptions/{subscriptionId}/peerings/{peeringId}": {
"put": {
"tags": [
"Subscriptions - Flexible"
],
"summary": "Update subscription peering",
"description": "Update an existing VPC peering in an existing subscription.",
"operationId": "updateVpcPeering",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "peeringId",
"in": "path",
"description": "VpcPeering Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VpcPeeringUpdateAwsRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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": [
"Subscriptions - Flexible"
],
"summary": "Delete subscription peering",
"description": "Deletes a VPC peering identified by an id",
"operationId": "deleteVpcPeering",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "peeringId",
"in": "path",
"description": "VpcPeering Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 "
}
}
}
},
"/subscriptions/{subscriptionId}/databases/{databaseId}": {
"get": {
"tags": [
"Databases - Flexible"
],
"summary": "Get database by id",
"description": "Information on a specific database identified by subscription Id and database Id",
"operationId": "getSubscriptionDatabaseByID",
"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": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Database"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 - Flexible"
],
"summary": "Update database",
"description": "Update an existing database",
"operationId": "updateDatabase",
"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/DatabaseUpdateRequest"
},
"example": "{  \"dryRun\": false,  \"name\": \"Redis-database-example\",  \"memoryLimitInGb\": 5,  \"throughputMeasurement\": {    \"by\": \"operations-per-second\",    \"value\": 10000  },  \"dataPersistence\": \"none\",  \"dataEvictionPolicy\": \"allkeys-lru\",  \"alerts\": [    {      \"name\": \"dataset-size\",      \"value\": 85    }  ]}"
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 - Flexible"
],
"summary": "Delete database",
"description": "Delete a specific database identified by subscription Id and database Id",
"operationId": "deleteDatabaseById",
"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": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 "
}
}
}
},
"/subscriptions/{subscriptionId}/databases/{databaseId}/regions": {
"put": {
"tags": [
"Databases - Flexible"
],
"summary": "Update active-active regions",
"description": "Update active-active local database properties",
"operationId": "updateCrdbLocalProperties",
"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/CrdbUpdatePropertiesRequest"
},
"example": "{  \"memoryLimitInGb\": 5,  \"regions\": [    {      \"region\": \"us-east-1\",      \"localThroughputMeasurement\": {        \"region\": \"us-east-1\",        \"writeOperationsPerSecond\": 1000,        \"readOperationsPerSecond\": 2000      },      \"alerts\": [        {          \"name\": \"dataset-size\",          \"value\": 80        }      ]    }  ],  \"dataEvictionPolicy\": \"allkeys-lru\"}"
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 "
}
}
}
},
"/subscriptions/{subscriptionId}/cidr": {
"get": {
"tags": [
"Subscriptions - Flexible"
],
"summary": "Get subscription CIDR",
"description": "Get CIDR  whitelist",
"operationId": "getCidrWhiteList",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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": [
"Subscriptions - Flexible"
],
"summary": "Update subscription CIDR",
"description": "Update subscription CIDR whitelist",
"operationId": "updateSubscriptionCidrWhiteList",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CidrWhiteListUpdateRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 "
}
}
}
},
"/fixed/subscriptions/{subscriptionId}": {
"get": {
"tags": [
"Subscriptions - Fixed"
],
"summary": "Get fixed subscription by id",
"description": "Information on fixed subscription identified by subscription Id",
"operationId": "getSubscriptionById_1",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FixedSubscription"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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": [
"Subscriptions - Fixed"
],
"summary": "Update fixed subscription",
"description": "Update a fixed subscription",
"operationId": "updateSubscription_1",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FixedSubscriptionUpdateRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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": [
"Subscriptions - Fixed"
],
"summary": "Delete fixed subscription",
"description": "Delete a fixed subscription identified by subscription Id (subscription must be empty, i.e. cannot contain databases)",
"operationId": "deleteSubscriptionById_1",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 "
}
}
}
},
"/fixed/subscriptions/{subscriptionId}/databases/{databaseId}": {
"get": {
"tags": [
"Databases - Fixed"
],
"summary": "Get fixed database by id",
"description": "Information on a specific database identified by fixed subscription Id and database Id",
"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": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FixedDatabase"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 - Fixed"
],
"summary": "Update fixed database",
"description": "Update a specific database identified by a fixed subscription Id and database Id",
"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": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 - Fixed"
],
"summary": "Delete fixed database",
"description": "Delete a specific database identified by a fixed subscription Id and database Id",
"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": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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 "
}
}
}
},
"/cloud-accounts/{cloudAccountId}": {
"get": {
"tags": [
"Cloud Accounts"
],
"summary": "Get cloud account by id",
"description": "Information on a specific cloud account",
"operationId": "getCloudAccountById",
"parameters": [
{
"name": "cloudAccountId",
"in": "path",
"description": "Cloud Account Id",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudAccount"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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": [
"Cloud Accounts"
],
"summary": "Update cloud account",
"description": "Update cloud account",
"operationId": "updateCloudAccount",
"parameters": [
{
"name": "cloudAccountId",
"in": "path",
"description": "Cloud Account Id",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudAccountUpdateRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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)"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"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": [
"Cloud Accounts"
],
"summary": "Delete cloud account",
"description": "Delete specified cloud account",
"operationId": "deleteCloudAccount",
"parameters": [
{
"name": "cloudAccountId",
"in": "path",
"description": "Cloud Account Id",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStateUpdate"
}
}
}
},
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"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 process