redislabs-openapi-spec.json

{"swagger":"2.0","info":{"description":"Redis Labs Pro API ","version":"Version 1","title":"Redis Labs Cloud API - Version 1","contact":{"name":"Customer Support","url":"https://support.redislabs.com","email":"[email protected]"},"license":{}},"host":"api.redislabs.com","basePath":"/v1","tags":[{"name":"Account","description":"Current account and ownership information"},{"name":"Subscriptions","description":"All operations related to subscriptions lifecycle"},{"name":"Databases","description":"All operations related to databases lifecycle"},{"name":"Cloud Accounts","description":"All operations related to cloud accounts (RV only)"},{"name":"Tasks","description":"Displays information on long running operations"}],"produces":["application/json"],"paths":{"/":{"get":{"tags":["Account"],"summary":"Get current Account","description":"Current account and related information","operationId":"getCurrentAccountUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RootAccount"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/cloud-accounts":{"get":{"tags":["Cloud Accounts"],"summary":"Get cloud accounts","description":"List all configured cloud accounts","operationId":"getCloudAccountsUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CloudAccounts"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false},"post":{"tags":["Cloud Accounts"],"summary":"Create cloud account","description":"Create cloud account","operationId":"createCloudAccountUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Cloud Account definition","required":true,"schema":{"$ref":"#/definitions/CloudAccountCreateRequest"}}],"responses":{"201":{"description":"Created"},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/cloud-accounts/{cloudAccountId}":{"get":{"tags":["Cloud Accounts"],"summary":"Get cloud account by id","description":"Information on a specific cloud account","operationId":"getCloudAccountByIdUsingGET","produces":["application/json"],"parameters":[{"name":"cloudAccountId","in":"path","description":"Cloud Account Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CloudAccount"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false},"put":{"tags":["Cloud Accounts"],"summary":"Update cloud account","description":"Update cloud account","operationId":"updateCloudAccountUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"cloudAccountId","in":"path","description":"Cloud Account Id","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"Cloud Account definition","required":true,"schema":{"$ref":"#/definitions/CloudAccountUpdateRequest"}}],"responses":{"201":{"description":"Created"},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false},"delete":{"tags":["Cloud Accounts"],"summary":"Delete cloud account","description":"Delete specified cloud account","operationId":"deleteCloudAccountUsingDELETE","produces":["application/json"],"parameters":[{"name":"cloudAccountId","in":"path","description":"Cloud Account Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/data-persistence":{"get":{"tags":["Account"],"summary":"Get list of data persistence options","description":"Lookup list of data persistence values","operationId":"getDataPersistenceOptionsUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DataPersistenceOptions"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/database-modules":{"get":{"tags":["Account"],"summary":"Get modules","description":"Lookup list of database modules supported in current account (support may differ based on subscription and database settings)","operationId":"getSupportedDatabaseModulesUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ModulesData"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/logs":{"get":{"tags":["Account"],"summary":"Get system log","description":"System log information for current account","operationId":"getAccountSystemLogsUsingGET","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of items to return","required":false,"type":"string","allowEmptyValue":false,"x-example":"100"},{"name":"offset","in":"query","description":"Number of items to skip","required":false,"type":"string","allowEmptyValue":false,"x-example":"0"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AccountSystemLogEntries"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/payment-methods":{"get":{"tags":["Account"],"summary":"Get payment methods","description":"Lookup list of current Account's payment methods","operationId":"getAccountPaymentMethodsUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentMethods"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/plans":{"get":{"tags":["Account"],"summary":"Get Plans","description":"Lookup list of plans","operationId":"getSupportedPlansUsingGET","produces":["application/json"],"parameters":[{"name":"provider","in":"query","description":"Provider Name","required":false,"type":"string","allowEmptyValue":false,"enum":["AWS","GCP"]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Plans"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/regions":{"get":{"tags":["Account"],"summary":"Get Regions","description":"Lookup list of regions for cloud provider","operationId":"getSupportedRegionsUsingGET","produces":["application/json"],"parameters":[{"name":"provider","in":"query","description":"Provider Name","required":false,"type":"string","allowEmptyValue":false,"enum":["AWS","GCP"]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Regions"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/subscriptions":{"get":{"tags":["Subscriptions"],"summary":"Get subscriptions","description":"Information on current account's subscriptions","operationId":"getAllSubscriptionsUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AccountSubscriptions"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false},"post":{"tags":["Subscriptions"],"summary":"Create subscription","description":"Create a new subscription","operationId":"createSubscriptionUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Subscription create request","required":true,"schema":{"$ref":"#/definitions/SubscriptionCreateRequest"}}],"responses":{"201":{"description":"Created"},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/subscriptions/{subscriptionId}":{"get":{"tags":["Subscriptions"],"summary":"Get subscription by id","description":"Information on subscription identified by subscription Id","operationId":"getSubscriptionByIdUsingGET","produces":["application/json"],"parameters":[{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Subscription"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false},"put":{"tags":["Subscriptions"],"summary":"Update subscription","description":"Update an existing subscription by Id","operationId":"updateSubscriptionUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Subscription update request","required":true,"schema":{"$ref":"#/definitions/SubscriptionUpdateRequest"}},{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false},"delete":{"tags":["Subscriptions"],"summary":"Delete subscription","description":"Delete a subscription identified by subscription Id (subscription must be empty, i.e. cannot contain databases)","operationId":"deleteSubscriptionByIdUsingDELETE","produces":["application/json"],"parameters":[{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/subscriptions/{subscriptionId}/cidr":{"get":{"tags":["Subscriptions"],"summary":"Get subscription CIDR","description":"Get CIDR  whitelist","operationId":"getCidrWhiteListUsingGET","produces":["application/json"],"parameters":[{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Successfully retrieved requested resource"},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false},"put":{"tags":["Subscriptions"],"summary":"Update subscription CIDR","description":"Update subscription CIDR whitelist","operationId":"updateSubscriptionCidrWhiteListUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Update subscription","required":true,"schema":{"$ref":"#/definitions/CidrWhiteListUpdateRequest"}},{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"201":{"description":"Created"},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/subscriptions/{subscriptionId}/databases":{"get":{"tags":["Databases"],"summary":"Get databases","description":"Information on databases belonging to subscription identified by subscription Id","operationId":"getSubscriptionDatabasesUsingGET","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of items to return","required":false,"type":"integer","format":"int32","allowEmptyValue":false,"x-example":100},{"name":"offset","in":"query","description":"Number of items to skip","required":false,"type":"integer","format":"int32","allowEmptyValue":false,"x-example":0},{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AccountSubscriptionDatabases"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false},"post":{"tags":["Databases"],"summary":"Create database","description":"Create a new database","operationId":"createDatabaseUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Database definition","required":true,"schema":{"$ref":"#/definitions/DatabaseCreateRequest"}},{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"201":{"description":"Created"},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/subscriptions/{subscriptionId}/databases/{databaseId}":{"get":{"tags":["Databases"],"summary":"Get database by id","description":"Information on a specific database identified by subscription Id and database Id","operationId":"getSubscriptionDatabaseByIDUsingGET","produces":["application/json"],"parameters":[{"name":"databaseId","in":"path","description":"Database Id","required":true,"type":"integer","format":"int32"},{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Database"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false},"put":{"tags":["Databases"],"summary":"Update database","description":"Update an existing database","operationId":"updateDatabaseUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"databaseId","in":"path","description":"Database Id","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"Database update request","required":true,"schema":{"$ref":"#/definitions/DatabaseUpdateRequest"}},{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false},"delete":{"tags":["Databases"],"summary":"Delete database","description":"Delete a specific database identified by subscription Id and database Id","operationId":"deleteDatabaseByIdUsingDELETE","produces":["application/json"],"parameters":[{"name":"databaseId","in":"path","description":"Database Id","required":true,"type":"integer","format":"int32"},{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/subscriptions/{subscriptionId}/databases/{databaseId}/backup":{"post":{"tags":["Databases"],"summary":"Backup database","description":"Manually backup a database into the destination defined for it","operationId":"backupDatabaseUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"databaseId","in":"path","description":"Database Id","required":true,"type":"integer","format":"int32"},{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/subscriptions/{subscriptionId}/databases/{databaseId}/import":{"post":{"tags":["Databases"],"summary":"Import database","description":"Import data from an RDB file or a different Redis database","operationId":"importDatabaseUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"databaseId","in":"path","description":"Database Id","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"Database import request","required":true,"schema":{"$ref":"#/definitions/DatabaseImportRequest"}},{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/subscriptions/{subscriptionId}/peerings":{"get":{"tags":["Subscriptions"],"summary":"Get Subscription peering","description":"Get VPC peering details. VPC peering for Google Cloud Provider must be enabled using the GCloud command line. For details, see documentation.","operationId":"getVpcPeeringUsingGET","produces":["application/json"],"parameters":[{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Successfully retrieved requested resource"},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false},"post":{"tags":["Subscriptions"],"summary":"Create subscription peering","description":"Create a new VPC peering in an existing subscription. VPC peering for Google Cloud Provider must be enabled using the GCloud command line. For details, see documentation.","operationId":"createVpcPeeringUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"VPC peering create request","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"201":{"description":"Created"},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/subscriptions/{subscriptionId}/peerings/{peeringId}":{"delete":{"tags":["Subscriptions"],"summary":"Delete subscription peering","description":"Deletes a VPC peering identified by an id","operationId":"deleteVpcPeeringUsingDELETE","produces":["application/json"],"parameters":[{"name":"peeringId","in":"path","description":"VpcPeering Id","required":true,"type":"integer","format":"int32"},{"name":"subscriptionId","in":"path","description":"Subscription Id","required":true,"type":"integer","format":"int32"}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/tasks":{"get":{"tags":["Tasks"],"summary":"Get tasks","description":"Currently active long running operations","operationId":"getAllTasksUsingGET","responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TasksStateUpdate"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}},"/tasks/{taskId}":{"get":{"tags":["Tasks"],"summary":"Get task by id","description":"Get specific long running operation, identified by Task Id","operationId":"getTaskByIdUsingGET","produces":["application/json"],"parameters":[{"name":"taskId","in":"path","description":"Task Id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TaskStateUpdate"}},"401":{"description":"Authentication failed for requested resource"},"403":{"description":"Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"},"404":{"description":"The resource you were trying to reach was not found or does not exist"},"429":{"description":"Too many subscriptions are concurrently created / updated / deleted in the account. Please re-submit API requests after subscription changes are completed"},"500":{"description":"Internal system error. If this error persists, please contact customer support"}},"security":[{"x-api-key":[]},{"x-api-secret-key":[]}],"deprecated":false}}},"securityDefinitions":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header"},"x-api-secret-key":{"type":"apiKey","name":"x-api-secret-key","in":"header"}},"definitions":{"AccountSubscriptionDatabases":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"accountId":{"type":"integer","format":"int32"}},"title":"AccountSubscriptionDatabases","description":"RedisLabs Account Subscription Databases information"},"AccountSubscriptions":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"accountId":{"type":"integer","format":"int32"}},"title":"AccountSubscriptions","description":"RedisLabs list of subscriptions in current account"},"AccountSystemLogEntries":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"entries":{"type":"array","items":{"$ref":"#/definitions/AccountSystemLogEntry"}}},"title":"AccountSystemLogEntries"},"AccountSystemLogEntry":{"type":"object","properties":{"apiKeyName":{"type":"string"},"description":{"type":"string"},"id":{"type":"integer","format":"int32"},"originator":{"type":"string"},"resource":{"type":"string"},"time":{"type":"string","format":"date-time"},"type":{"type":"string"}},"title":"AccountSystemLogEntry","description":"Account system log entry"},"CidrWhiteListUpdateRequest":{"type":"object","properties":{"cidrIps":{"type":"array","description":"CIDR values in an array format (example: ['10.1.1.0/32'])","items":{"type":"string"}},"securityGroupIds":{"type":"array","description":"AWS Security group identifier","items":{"type":"string"}}},"title":"CidrWhiteListUpdateRequest","description":"cidr whitelist creation request message"},"CloudAccount":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"accessKeyId":{"type":"string"},"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"provider":{"type":"string","enum":["AWS","GCP"]},"signInLoginUrl":{"type":"string"},"status":{"type":"string"}},"title":"CloudAccount","description":"RedisLabs Cloud Account information"},"CloudAccountCreateRequest":{"type":"object","required":["accessKeyId","accessSecretKey","consolePassword","consoleUsername","name","signInLoginUrl"],"properties":{"accessKeyId":{"type":"string","example":"****","description":"Required. Cloud provider access key"},"accessSecretKey":{"type":"string","example":"****","description":"Required. Cloud provider secret key"},"consolePassword":{"type":"string","example":"****","description":"Required. Cloud provider management console password"},"consoleUsername":{"type":"string","example":"[email protected]","description":"Required. Cloud provider management console username"},"name":{"type":"string","example":"My new Cloud Account","description":"Required. Cloud account display name"},"provider":{"type":"string","example":"AWS","description":"Optional. Cloud provider. Default: 'AWS'","enum":["AWS","GCP"]},"signInLoginUrl":{"type":"string","example":"https://<aws-account-identifier>.signin.aws.amazon.com/console","description":"Required. Cloud provider management console login URL"}},"title":"CloudAccountCreateRequest","description":"Cloud Account creation request message"},"CloudAccountUpdateRequest":{"type":"object","required":["accessKeyId","accessSecretKey","consolePassword","consoleUsername"],"properties":{"accessKeyId":{"type":"string","example":"****","description":"Required. Cloud provider access key"},"accessSecretKey":{"type":"string","example":"****","description":"Required. Cloud provider secret key"},"consolePassword":{"type":"string","example":"****","description":"Required. Cloud provider management console password"},"consoleUsername":{"type":"string","example":"[email protected]","description":"Required. Cloud provider management console username"},"name":{"type":"string","example":"My new Cloud Account","description":"name"},"signInLoginUrl":{"type":"string","example":"https://<aws-account-identifier>.signin.aws.amazon.com/console","description":"Optional. Cloud provider management console login URL"}},"title":"CloudAccountUpdateRequest","description":"Cloud Account update request message"},"CloudAccounts":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"accountId":{"type":"integer","format":"int32"}},"title":"CloudAccounts","description":"RedisLabs Cloud Accounts information"},"CloudApiError":{"type":"object","properties":{"description":{"type":"string"},"httpStatus":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}},"title":"CloudApiError"},"DataPersistenceEntry":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"}},"title":"DataPersistenceEntry","description":"RedisLabs data persistence information"},"DataPersistenceOptions":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"dataPersistence":{"type":"array","items":{"$ref":"#/definitions/DataPersistenceEntry"}}},"title":"DataPersistenceOptions"},"Database":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"activatedOn":{"type":"string","format":"date-time"},"dataEvictionPolicy":{"type":"string","enum":["allkeys-lru","allkeys-lfu","allkeys-random","volatile-lru","volatile-lfu","volatile-random","volatile-ttl","noeviction"]},"dataPersistence":{"type":"string","enum":["none","aof-every-1-second","aof-every-write","snapshot-every-1-hour","snapshot-every-6-hours","snapshot-every-12-hours"]},"databaseId":{"type":"integer","format":"int32"},"lastModified":{"type":"string","format":"date-time"},"memoryLimitInGb":{"type":"number","format":"double"},"memoryStorage":{"type":"string","enum":["ram","ram-and-flash"]},"memoryUsedInMb":{"type":"number","format":"double"},"name":{"type":"string"},"privateEndpoint":{"type":"string"},"protocol":{"type":"string","enum":["redis","memcached"]},"provider":{"type":"string","enum":["AWS","GCP"]},"publicEndpoint":{"type":"string"},"redisVersionCompliance":{"type":"string"},"region":{"type":"string"},"replication":{"type":"boolean"},"status":{"type":"string"},"supportOSSClusterApi":{"type":"boolean"}},"title":"Database","description":"RedisLabs database information"},"DatabaseAlertSpec":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","example":"dataset-size","description":"Required. Alert name","enum":["dataset-size","throughput-higher-than","throughput-lower-than","latency","syncsource-error","syncsource-lag"]},"value":{"type":"integer","format":"int32","example":80,"description":"Required. Alert value"}},"title":"DatabaseAlertSpec"},"DatabaseCreateRequest":{"type":"object","required":["memoryLimitInGb","name"],"properties":{"dryRun":{"type":"boolean","example":false,"description":"Optional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'true'"},"name":{"type":"string","example":"Redis-database-example","description":"Required. Database name (Database name must be up to 40 characters long, include only letters, digits, or hyphen ('-'), start with a letter, and end with a letter or digit)"},"protocol":{"type":"string","description":"Optional. Database protocol: either 'redis' or 'memcached'. Default: 'redis'","enum":["redis","memcached"]},"memoryLimitInGb":{"type":"number","format":"double","example":1.0,"description":"Required. Maximum memory usage for this specific database"},"supportOSSClusterApi":{"type":"boolean","example":false,"description":"Optional. Support Redis open-source (OSS) Cluster API. Default: 'false'"},"useExternalEndpointForOSSClusterApi":{"type":"boolean","example":false,"description":"Optional. Should use external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled'. Default: 'false'"},"dataPersistence":{"type":"string","description":"Optional. Rate of database data persistence (in persistent storage). Default: 'none'","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 items eviction method. Default: 'volatile-lru'","enum":["allkeys-lru","allkeys-lfu","allkeys-random","volatile-lru","volatile-lfu","volatile-random","volatile-ttl","noeviction"]},"replication":{"type":"boolean","description":"Optional. Databases replication. Default: 'true'"},"throughputMeasurement":{"description":"Optional. Throughput measurement method. Default: 25000 ops/sec","$ref":"#/definitions/DatabaseThroughputSpec"},"averageItemSizeInBytes":{"type":"integer","format":"int64","description":"Optional. Relevant only to ram-and-flash subscriptions. Estimated average size (measured in bytes) of the items stored in the database, Default: 1000"},"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 Labs Cloud instance, only host and port should be provided (using the format: ['redis://endpoint1:6379', 'redis://endpoint2:6380']).","items":{"type":"string"}},"periodicBackupPath":{"type":"string","example":"s3://<backup-path>","description":"Optional. AWS S3 path that will be used to store database backup files"},"sourceIp":{"type":"array","description":"Optional. List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. example value: '['192.168.10.0/32', '192.168.12.0/24']'","items":{"type":"string"}},"clientSslCertificate":{"type":"string","description":"Optional. SSL certificate to authenticate user connections"},"password":{"type":"string","description":"Optional. Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated"},"alerts":{"type":"array","description":"Optional. Redis Labs database alerts","items":{"$ref":"#/definitions/DatabaseAlertSpec"}},"modules":{"type":"array","description":"Optional. Redis Labs modules to be provisioned in the database","items":{"$ref":"#/definitions/DatabaseModuleSpec"}}},"title":"DatabaseCreateRequest","description":"Database creation request message"},"DatabaseImportRequest":{"type":"object","required":["importFromUri","sourceType"],"properties":{"sourceType":{"type":"string","example":"http","description":"Required. Type of storage source from which to import the database file (RDB files) or data (Redis connection)","enum":["http","redis","ftp","aws-s3","azure-blob-storage","google-blob-storage"]},"importFromUri":{"type":"array","description":"Required. One or more URIs to source data files or Redis databases, as appropriate to specified source type (example: ['http://mydomain.com/redis-backup-file1', 'http://mydomain.com/redis-backup-file2'])","items":{"type":"string"}}},"title":"DatabaseImportRequest","description":"Database import request message"},"DatabaseModuleSpec":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Required. Redis Labs module Id"},"parameters":{"type":"object","description":"Optional. Redis Labs database module parameters (name and value), as relevant to the specific module (see modules parameters specification) "}},"title":"DatabaseModuleSpec"},"DatabaseThroughputSpec":{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","description":"Required. Throughput measurement method. Either 'number-of-shards' or 'operations-per-second'","enum":["operations-per-second","number-of-shards"]},"value":{"type":"integer","format":"int64","example":10000,"description":"Required. Throughput value (as applies to selected measurement method)"}},"title":"DatabaseThroughputSpec"},"DatabaseUpdateRequest":{"type":"object","properties":{"dryRun":{"type":"boolean","example":false,"description":"Optional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'true'"},"name":{"type":"string","example":"Redis-database-example-updated","description":"Optional. Database name"},"memoryLimitInGb":{"type":"number","format":"double","example":1.0,"description":"Optional. Maximum memory usage for this specific database"},"supportOSSClusterApi":{"type":"boolean","example":false,"description":"Optional. Support Redis open-source (OSS) Cluster API"},"useExternalEndpointForOSSClusterApi":{"type":"boolean","example":false,"description":"Optional. Should use external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled'. Default: 'false'"},"dataEvictionPolicy":{"type":"string","description":"Optional. Data items eviction method","enum":["allkeys-lru","allkeys-lfu","allkeys-random","volatile-lru","volatile-lfu","volatile-random","volatile-ttl","noeviction"]},"replication":{"type":"boolean","description":"Optional. Databases replication"},"throughputMeasurement":{"description":"Optional. Throughput measurement method. Default: 25000 ops/sec","$ref":"#/definitions/DatabaseThroughputSpec"},"regexRules":{"type":"array","description":"Optional. Shard regex rules. Relevant only for a sharded database","items":{"type":"string"}},"dataPersistence":{"type":"string","description":"Optional. Rate of database data persistence (in persistent storage)","enum":["none","aof-every-1-second","aof-every-write","snapshot-every-1-hour","snapshot-every-6-hours","snapshot-every-12-hours"]},"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 Labs Cloud instance, only host and port should be provided (using the format: ['redis://endpoint1:6379', 'redis://endpoint2:6380'] ).","items":{"type":"string"}},"periodicBackupPath":{"type":"string","example":"s3://<backup-path>","description":"Optional. If specified, database will be able to perform backups to this path. If empty string is received, backup path will be removed"},"sourceIp":{"type":"array","description":"Optional. List of source IP addresses or subnet masks. 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"}},"clientSslCertificate":{"type":"string","example":"ssl-certificate","description":"Optional. If specified, this SSL certificate will be required to authenticate user connections. If empty string is received, SSL certificate will be removed"},"password":{"type":"string","example":"P@ssw0rd","description":"Optional. If specified, this password will be used to access the database"},"alerts":{"type":"array","description":"Optional. Redis Labs database alerts","items":{"$ref":"#/definitions/DatabaseAlertSpec"}}},"title":"DatabaseUpdateRequest","description":"Database update request message"},"JsonNode":{"type":"object","properties":{"array":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"binary":{"type":"boolean"},"boolean":{"type":"boolean"},"containerNode":{"type":"boolean"},"double":{"type":"boolean"},"float":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"int":{"type":"boolean"},"integralNumber":{"type":"boolean"},"long":{"type":"boolean"},"missingNode":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"null":{"type":"boolean"},"number":{"type":"boolean"},"object":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"textual":{"type":"boolean"},"valueNode":{"type":"boolean"}},"title":"JsonNode"},"Link":{"type":"object","properties":{"deprecation":{"type":"string","xml":{"name":"deprecation","attribute":true,"wrapped":false}},"href":{"type":"string","xml":{"name":"href","attribute":true,"wrapped":false}},"hreflang":{"type":"string","xml":{"name":"hreflang","attribute":true,"wrapped":false}},"media":{"type":"string","xml":{"name":"media","attribute":true,"wrapped":false}},"rel":{"type":"string","xml":{"name":"rel","attribute":true,"wrapped":false}},"templated":{"type":"boolean"},"title":{"type":"string","xml":{"name":"title","attribute":true,"wrapped":false}},"type":{"type":"string","xml":{"name":"type","attribute":true,"wrapped":false}}},"title":"Link"},"Module":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"}},"title":"Module","description":"RedisLabs database module information"},"ModulesData":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"modules":{"type":"array","items":{"$ref":"#/definitions/Module"}}},"title":"ModulesData"},"PaymentMethods":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"accountId":{"type":"integer","format":"int32"}},"title":"PaymentMethods","description":"RedisLabs Account payment methods"},"Plan":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"maximumNumberOfDatabases":{"type":"integer","format":"int32"},"memorySizeInMb":{"type":"integer","format":"int64"},"name":{"type":"string"},"planType":{"type":"string"},"price":{"type":"number","format":"float"},"priceCurrency":{"type":"string"},"pricePeriod":{"type":"string"},"provider":{"type":"string","enum":["AWS","GCP"]},"region":{"type":"string"},"supportsMultipleAvailabilityZones":{"type":"boolean"},"supportsRedisOnFlash":{"type":"boolean"},"throughputOperationsPerSecond":{"type":"integer","format":"int32"}},"title":"Plan","description":"RedisLabs plan information"},"Plans":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"plans":{"type":"array","items":{"$ref":"#/definitions/Plan"}}},"title":"Plans"},"ProcessorResponse":{"type":"object","properties":{"additionalInfo":{"type":"string"},"additionalResourceId":{"type":"integer","format":"int32"},"error":{"$ref":"#/definitions/CloudApiError"},"resource":{"type":"object"},"resourceId":{"type":"integer","format":"int32"}},"title":"ProcessorResponse"},"Region":{"type":"object","properties":{"name":{"type":"string"},"provider":{"type":"string","enum":["AWS","GCP"]}},"title":"Region","description":"RedisLabs region information"},"Regions":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"regions":{"type":"array","items":{"$ref":"#/definitions/Region"}}},"title":"Regions"},"RootAccount":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}}},"title":"RootAccount"},"Subscription":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"id":{"type":"integer","format":"int32"},"memoryStorage":{"type":"string","enum":["ram","ram-and-flash"]},"name":{"type":"string"},"numberOfDatabases":{"type":"integer","format":"int32"},"paymentMethodId":{"type":"integer","format":"int32"},"status":{"type":"string"},"storageEncryption":{"type":"boolean"},"subscriptionPricing":{"type":"array","items":{"$ref":"#/definitions/SubscriptionPricing"}}},"title":"Subscription","description":"RedisLabs Subscription information"},"SubscriptionCreateRequest":{"type":"object","required":["cloudProviders","databases"],"properties":{"name":{"type":"string","example":"My new subscription","description":"Optional. Subscription name"},"dryRun":{"type":"boolean","example":false,"description":"Optional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'true'"},"planId":{"type":"integer","format":"int32","description":"Optional. A predefined plan Id (see lookup API '/plans'). If specified, the plan defines the billing for the created subscription and overrides deployment and configuration based on specific plan details."},"paymentMethodId":{"type":"integer","format":"int32","description":"A valid payment method (credit card, wire transfer etc) pre-defined in the current account. It will be billed for any charges related to the created subscription). Not allowed for GCP account "},"memoryStorage":{"type":"string","example":"ram","description":"Optional. Memory storage preference: either 'ram' or a combination of 'ram-and-flash'. Default: 'ram'","enum":["ram","ram-and-flash"]},"persistentStorageEncryption":{"type":"boolean","example":false,"description":"Optional. Encrypt data stored in persistent storage. Required for a GCP subscription. Default: 'false'"},"cloudProviders":{"type":"array","description":"Required. Cloud hosting & networking details","items":{"$ref":"#/definitions/SubscriptionSpec"}},"databases":{"type":"array","description":"Required. Databases specifications for each planned database","items":{"$ref":"#/definitions/SubscriptionDatabaseSpec"}}},"title":"SubscriptionCreateRequest","description":"Subscription creation request message"},"SubscriptionDatabaseSpec":{"type":"object","required":["memoryLimitInGb","name"],"properties":{"throughputMeasurementBy":{"type":"string","enum":["operations-per-second","number-of-shards"]},"throughputMeasurementValue":{"type":"integer","format":"int64"},"name":{"type":"string","example":"Redis-database-example","description":"Required. Database name (Database name must be up to 40 characters long, include only letters, digits, or hyphen ('-'), start with a letter, and end with a letter or digit)"},"protocol":{"type":"string","description":"Optional. Database protocol: either 'redis' or 'memcached'. Default: 'redis'","enum":["redis","memcached"]},"memoryLimitInGb":{"type":"number","format":"double","example":1.0,"description":"Required. Maximum memory usage for this specific database"},"supportOSSClusterApi":{"example":false,"description":"Optional. Support Redis open-source (OSS) Cluster API. Default: 'false'","$ref":"#/definitions/JsonNode"},"dataPersistence":{"type":"string","description":"Optional. Rate of database data persistence (in persistent storage). Default: 'none'","enum":["none","aof-every-1-second","aof-every-write","snapshot-every-1-hour","snapshot-every-6-hours","snapshot-every-12-hours"]},"replication":{"description":"Optional. Databases replication. Default: 'true'","$ref":"#/definitions/JsonNode"},"throughputMeasurement":{"description":"Optional. Throughput measurement method. Default: 25000 ops/sec","$ref":"#/definitions/DatabaseThroughputSpec"},"modules":{"type":"array","description":"Optional. Redis Labs modules to be provisioned in the database","items":{"$ref":"#/definitions/DatabaseModuleSpec"}},"quantity":{"type":"integer","format":"int32","example":1,"description":"Optional. Number of databases (of this type) that will be created. Default: 1"},"averageItemSizeInBytes":{"type":"integer","format":"int64","description":"Optional. Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes) of the items stored in the database. Default: 1000"}},"title":"SubscriptionDatabaseSpec"},"SubscriptionPricing":{"type":"object","properties":{"databaseName":{"type":"string"},"priceCurrency":{"type":"string"},"pricePerUnit":{"type":"number","format":"double"},"pricePeriod":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"quantityMeasurement":{"type":"string"},"type":{"type":"string"},"typeDetails":{"type":"string"}},"title":"SubscriptionPricing"},"SubscriptionRegionNetworkingSpec":{"type":"object","required":["deploymentCIDR"],"properties":{"deploymentCIDR":{"type":"string","example":"10.0.0.0/24","description":"Optional. Deployment CIDR mask. \nDefault: If using Redis Labs internal cloud account, 192.168.0.0/24"},"vpcId":{"type":"string","example":"<vpc-identifier>","description":"Optional. Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: 'vpc-0125be68a4625884ad') and existing within the hosting account"}},"title":"SubscriptionRegionNetworkingSpec"},"SubscriptionRegionSpec":{"type":"object","required":["region"],"properties":{"region":{"type":"string","example":"us-east-1","description":"Required. Deployment region as defined by cloud provider"},"multipleAvailabilityZones":{"type":"boolean","example":false,"description":"Optional. Support deployment on multiple availability zones within the selected region. Default: 'false'"},"preferredAvailabilityZones":{"type":"array","description":"Optional. Availability zones deployment preferences (for the selected provider & region). Example = '['us-east-1a', 'us-east-1c', 'us-east-2e']'","items":{"type":"string"}},"networking":{"description":"Optional. Cloud networking details, per region (single region or multiple regions for Active-Active cluster only). Default: if using Redis Labs internal cloud account, 192.168.0.0/24","$ref":"#/definitions/SubscriptionRegionNetworkingSpec"}},"title":"SubscriptionRegionSpec"},"SubscriptionSpec":{"type":"object","required":["regions"],"properties":{"provider":{"type":"string","example":"AWS","description":"Optional. Cloud provider. Default: 'AWS'","enum":["AWS","GCP"]},"cloudAccountId":{"type":"integer","format":"int32","example":1,"description":"Optional. Cloud account identifier. Default: Redis Labs internal cloud account (using Cloud Account Id = 1 implies using Redis Labs internal cloud account). Note that a GCP subscription can be created only with Redis Labs internal cloud account."},"regions":{"type":"array","description":"Required. Cloud networking details, per region (single region or multiple regions for Active-Active cluster only)","items":{"$ref":"#/definitions/SubscriptionRegionSpec"}}},"title":"SubscriptionSpec"},"SubscriptionUpdateRequest":{"type":"object","properties":{"name":{"type":"string","example":"My new subscription name","description":"Subscription name"},"paymentMethodId":{"type":"integer","format":"int32","description":"Payment method Id"}},"title":"SubscriptionUpdateRequest","description":"Subscription update request message"},"TaskStateUpdate":{"type":"object","properties":{"_links":{"type":"array","xml":{"name":"link","attribute":false,"wrapped":false},"items":{"$ref":"#/definitions/Link"}},"commandType":{"type":"string"},"description":{"type":"string"},"response":{"$ref":"#/definitions/ProcessorResponse"},"status":{"type":"string","enum":["initialized","received","processing-in-progress","processing-completed","processing-error"]},"taskId":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"}},"title":"TaskStateUpdate"},"TasksStateUpdate":{"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/definitions/TaskStateUpdate"}}},"title":"TasksStateUpdate"}}}