{"openapi":"3.0.0","info":{"title":"ScyllaDB Cloud API","version":"1.0.0","description":"### Error codes mapping\n\t000001\tToo many requests sent from your IP address. Please try again in a minute.\n\t000002\tYou do not have the required permissions to perform this action\n\t010101\tError retrieving default account\n\t010201\tError retrieving account info\n\t010301\tError retrieving countries\n\t010401\tInvalid request format\n\t010402\tYou are not allowed to change to this country. Please contact support\n\t010403\tError setting account country\n\t010501\tError getting account active credentials\n\t010601\tError sending cross account request\n\t010701\tError getting permissions\n\t010801\tInvalid \"type\" query parameter\n\t010802\tInvalid \"status\" query parameter\n\t010803\tAccount ID is missing\n\t010804\tInvalid request payload\n\t010805\tError setting notifications email\n\t010806\tProvided email is invalid\n\t010807\tAccount ID is missing\n\t010808\tError getting notifications email\n\t011001\tInvalid query parameter\n\t011002\tInvalid end/start query parameter, end after start\n\t011003\tInvalid end/start query parameter, minimum 30 minutes timespan\n\t011004\tUnexpected error occurred when account usage. Please contact support \n\t011100\tAccount has associated cluster resources\n\t020001\tUnauthorized\n\t020002\tAuthentication error\n\t020005\tOnly Bearer authorization token is supported\n\t020006\tAuthentication denied\n\t020101\tInvalid request format\n\t020102\tUnexpected error occurred when creating a user. Please contact support\n\t020104\tRegistration is restricted\n\t020201\tError creating user\n\t020202\tError verifying user\n\t020301\tInvalid request format\n\t020302\tUnexpected error occurred when login. Please contact support\n\t020303\tPlease check your email and complete your registration\n\t020304\tEmail or password is incorrect, please try again\n\t020305\tToo many failed login attempts, please try again in a few minutes\n\t020306\tYour password has expired. Please check your email for instructions\n\t020401\tInvalid request\n\t020402\tUnexpected error occurred when logout\n\t020501\tError retrieving user information\n\t020601\tInvalid request format\n\t020602\tUnexpected error occurred when reset password. Please contact support\n\t020701\tInvalid request format\n\t020702\tUnexpected error occurred when reset password. Please contact support\n\t020801\tInvalid request format\n\t020802\tUnexpected error occurred when reset password. Please contact support\n\t020803\tPassword was already used\n\t020901\tInvalid request format\n\t020902\tUnexpected error occurred when changing password. Please contact support\n\t020903\tCurrent password is incorrect\n\t020904\tTo help protect your account, please choose a password that you haven't used before\n\t020905\tNew password is incorrect\n\t021001\tInvalid request format\n\t021002\tError resending token\n\t021003\tUser already verified\n\t021101\tInvalid request format\n\t021102\tSession token is invalid or expired\n\t021201\tInvalid request format\n\t021202\tError updating user details\n\t021301\tInvalid request format\n\t021302\tError creating TOTP password\n\t021303\tInvalid user password\n\t021304\tUser already has MFA enabled\n\t021401\tInvalid request format\n\t021402\tError validating TOTP password\n\t021403\tUser already has MFA enabled\n\t021404\tInvalid TOTP UUID\n\t021405\tTOTP verification time expired\n\t021406\tInvalid user TOTP status\n\t021407\tInvalid user passcode\n\t021501\tInvalid request format\n\t021502\tGeneral error TOTP login\n\t021503\tUser should have MFA enabled\n\t021504\tInvalid session token\n\t021505\tInvalid session token status\n\t021506\tSession token expired\n\t021507\tInvalid user TOTP status\n\t021508\tInvalid user passcode\n\t021601\tInvalid request format\n\t021602\tDisable user TOTP general error\n\t021603\tInvalid user password\n\t021604\tUser should have MFA enabled\n\t021701\tInvalid request format\n\t021702\tValidate and disable user TOTP general error\n\t021703\tInvalid user password\n\t021704\tInvalid user TOTP status\n\t021705\tInvalid user passcode\n\t021801\tError creating monitor token\n\t021901\tInvalid request format\n\t021902\tError validating monitor token\n\t021903\tInvalid monitor token\n\t021904\tUser status is not Active\n\t021905\tUser ID mismatch\n\t022001\tUser is not found\n\t030101\tInvalid request format\n\t030102\tError adding billing card\n\t030201\tError retrieving billing info\n\t030202\tError adding account billing info\n\t030301\tError getting account billing info\n\t030401\tError getting billing card info\n\t040101\tInvalid request format\n\t040102\tError adding a new firewall rule\n\t040103\tThe firewall rule already exists\n\t040104\tInvalid firewall rule\n\t040105\tAllowed IPs range is too big. CIDR range suffix must be at least /16\n\t040201\tUnexpected error occurred when retrieving credentials. Please contact support.\n\t040301\tGeneral error with retrieving the allowed firewall list\n\t040401\tGeneral error with retrieving the nodes list\n\t040501\tInvalid request format\n\t040502\tGeneral error with retrieving the cluster extended info\n\t040601\tGeneral error with retrieving the clusters list\n\t040701\tInvalid request format\n\t040702\tUnexpected error occurred when creating a cluster. Please contact support\n\t040703\tA cluster with this name already exists, please use another name\n\t040704\tProvided cluster network range is too small\n\t040705\tProvided cluster network does not belong to a private network\n\t040706\tProvided cluster network range is too big\n\t040707\tAccount is not eligible for free-tier\n\t040708\tInvalid number of nodes for free tier cluster\n\t040709\tInstance type not eligible for free tier cluster\n\t040710\tInvalid billing status\n\t040711\tGiven service version requires AlternatorWriteIsolation\n\t040712\tProvided cluster name should be 2-63 characters, start and end with an alphanumeric character\n\t040713\tProvided cluster network CIDR block is reserved and cannot be used. Please use a different CIDR block\n\t040714\tAllowed IPs range is too big. CIDR range suffix must be at least /16\n\t040715\tAccount cloud provider is not supported for deferred billing info\n\t040716\tAccount is not active\n\t040717\tAccount is not eligible for deferred billing info since billing is verified\n\t040718\tAccount is not eligible for deferred billing since there is no active cloud account\n\t040719\tDeferred billing period has been already initiated for this account\n\t040720\tThe period allowing no billing information is expired\n\t040722\tAccount billing is not verified\n\t040723\tAccount does not have encryption at rest enabled\n\t040724\tGeneral error related to key service\n\t040725\tInvalid request's expiration format\n\t040726\tToo many maintenance windows\n\t040727\tMaintenance window schedule rule format is invalid\n\t040728\tMaintenance window schedule rule is invalid\n\t040729\tMaintenance window duration is too short\n\t040730\tMaintenance window time is out of working hours\n\t040731\tMaintenance windows overlap with each other\n\t040732\tNot enough maintenance windows\n\t040733\tInvalid encryption at rest parameter\n\t040734\tThe selected tablets mode is not supported for X-Cloud\n\t040735\tThe specified ScyllaDB version is not compatible with X-Cloud\n\t040736\tSetting Nodes or CloudProviderInstanceType is not allowed for clusters with X-Cloud scaling enabled\n\t040737\tClusters with X-Cloud scaling must specify exactly one: either valid InstanceFamilies or valid InstanceTypeIDs\n\t040738\tX-Cloud scaling is not available for free tier clusters\n\t040739\tOne of the scaling policy fields is not valid\n\t040740\tInvalid scaling mode\n\t040741\tAlternator is not supported when tablets are enabled\n\t040742\tInvalid vector search configuration\n\t040743\tOnly one vector search instance is allowed per availability zone\n\t040744\tVector search is already installed\n\t040745\tVector search is not supported on this cluster\n\t040746\tInvalid instance type for vector search\n\t040747\tMutually exclusive parameters provided for vector search\n\t040748\tToo many vector search nodes specified for the datacenter\n\t040749\tInvalid cloud account configuration\n\t040751\tThe specified instance type is not eligible for free tier clusters with vector search\n\t040752\tThe specified number of vector-search nodes is not eligible for free tier clusters\n\t040753\tMinimum number of zones required for placement mode not met\n\t040754\tThis region is temporarily unavailable for new clusters. Please select a different region.\n\t040801\tInvalid request format\n\t040802\tUnexpected error occurred when deleting a cluster. Please contact support\n\t040803\tCluster name is invalid\n\t040901\tError deleting the firewall allowed ip\n\t040902\tInvalid firewall rule\n\t041001\tInvalid request format\n\t041002\tUnexpected error occurred when resizing a cluster. Please contact support\n\t041003\tCluster DC must be active to resize the cluster\n\t041004\tFeature is not enabled on cluster\n\t041005\tResizing by this number of nodes is not permitted. Please contact support for assistance\n\t041006\tActive resize request exists\n\t041007\tNode count is not multiplication of Replication Factor\n\t041008\tClusters with X-Cloud scaling cannot be resized\n\t041009\tInvalid instance type\n\t041101\tInvalid request format\n\t041102\tThe CIDR block address provided is already in use. It overlaps either with the target VPC or with an already established VPC peering connection\n\t041103\tThis VPC is already peered\n\t041104\tThe cluster does not have VPC peering enabled\n\t041105\tThe VPC ID you provided is invalid\n\t041106\tThe AWS Account ID you provided is invalid\n\t041107\tCluster has no VPC\n\t041108\tCluster has multiple VPC\n\t041109\tThe provided Cluster network CIDR block is reserved and cannot be used. Please use a different CIDR block\n\t041111\tGeneral error creating VPC peering connection\n\t041112\tInvalid firewall rule\n\t041113\tCIDR range is too big, the prefix must be at least /16\n\t041114\tInvalid request parameter\n\t041115\tMissing peer region ID\n\t041116\tInvalid request format\n\t041117\tGeneral cloud API error\n\t041118\tOperation is not allowed\n\t041120\tUnexpected error occurred when listing VPC peering connections. Please contact support.\n\t041130\tUnexpected error occurred when deleting a VPC peering connection. Please contact support.\n\t041140\tGeneral error describing VPC peering connection\n\t041141\tVPC peering connection not found\n\t041142\tUnexpected error occurred when reading a VPC peering connection. Please contact support.\n\t041150\tUnexpected error occurred when retrieving cluster VPC list. Please contact support.\n\t041160\tGeneral error requesting prometheus proxy\n\t041170\tGeneral error getting prometheus proxy tokens\n\t041171\tPrometheus proxy tokens not found\n\t041180\tGeneral error disabling prometheus proxy\n\t041181\tPrometheus Proxy tokens not found\n\t041190\tGeneral error getting cluster requests\n\t041191\tInvalid \"type\" query parameter\n\t041192\tInvalid \"status\" query parameter\n\t041200\tGeneral error with retrieving cluster public certificate\n\t041201\tEncryption must be enabled to retrieve cluster public certificate\n\t041210\tGeneral error getting backup task history\n\t041300\tUnexpected error occurred when enabling DNS\n\t041301\tDNS support is already disabled on this cluster\n\t041302\tDNS support is already enabled on this cluster\n\t041303\tThere is another active DNS request in progress\n\t041400\tUnable to retrieve windows information\n\t041401\tUnable to retrieve cluster windows list\n\t041402\tBad request format, rrule is missing in request body\n\t041403\tBad request format, invalid rrule format\n\t041404\tBad request format, duration needs to be >= 0\n\t041405\tProvided windows overlaps with other windows\n\t041406\tWindow outside of working hours\n\t041407\tCan't delete more windows, minimum required windows reached\n\t041408\tCan't create more windows, maximum allowed number reached\n\t041409\tUnable to create maintenance window\n\t041410\tUnable to update the maintenance window\n\t041411\tUnable to delete maintenance window\n\t041412\tWindow outside of working hours\n\t041413\tUnable to return default maintenance windows\n\t041500\tUnable to change encryption mode\n\t041601\tInvalid query parameter\n\t041602\tInvalid end/start query parameter, end after start\n\t041603\tInvalid end/start query parameter, minimum 30 minutes timespan\n\t041604\tUnexpected error occurred when cluster usage. Please contact support \n\t041700\tInvalid input\n\t041702\tInvalid input\n\t041704\tCluster does not have a node reboot feature enabled\n\t041705\tCluster node doesn't exist\n\t041706\tCluster node is not in active state\n\t041707\tCluster is locked\n\t041708\tCluster has actions queued for processing\n\t041709\t'force' must be 'true' or 'false'\n\t041710\t'duration' must be in range 0..900\n\t0420001\tGeneral error getting datacenter list\n\t0420002\tGeneral error getting datacenter info\n\t0420003\tIll-formed datacenter ID\n\t0420004\tDatacenter not found\n\t0420005\tDatacenter does not belong to cluster\n\t0420006\tDatacenter is not active\n\t0420007\tGeneral error requesting to add data center\n\t0420008\tProvided CIDR block overlaps with another data center\n\t0420009\tProvided CIDR block overlaps with VPC peer\n\t0420010\tProvided CIDR range is too small\n\t0420011\tProvided CIDR does not belong to a private network\n\t0420012\tProvided CIDR does not belong to a private network\n\t0420014\tProvided CIDR block is reserved and cannot be used. Please use a different CIDR block\n\t0420015\tGeneral error creating datacenter rescale request\n\t0420017\tThe current and requested size are the same\n\t0420018\tFree tier clusters cannot be rescaled\n\t0420019\tDevelopment clusters cannot be rescaled\n\t0420020\tNode count must be a multiplication of RF\n\t0420021\tAccount billing is not verified\n\t0420022\tThis region is temporarily unavailable for adding new datacenters. Please select a different region.\n\t0430001\tInvalid query parameter\n\t0430002\tInvalid end/start query parameter, end after start\n\t0430003\tInvalid end/start query parameter, minimum 30 minutes timespan\n\t0430004\tUnexpected error occurred when cluster usage. Please contact support\n\t043001\tGeneral error updating cluster connection\n\t043002\tInvalid request format\n\t043003\tInvalid request format\n\t043005\tVPC peering not found\n\t043006\tProperty cidrlist is empty list\n\t043007\tProperty cidrlist can't have more than 5 entries\n\t043008\tProvided CIDRs overlaps reserved networks\n\t043009\tProvided CIDRs overlaps existing cluster datacenter CIDR\n\t043010\tIt is allowed to update only peering with status ACTIVE or INACTIVE\n\t043011\tProperty status validation failed, it can only be \"ACTIVE\",\"INACTIVE\"\n\t043012\tProperty status validation failed\n\t044001\tInvalid request format\n\t044002\tGeneral error renaming the cluster\n\t044003\tCluster must be active to rename the cluster\n\t044004\tCluster name must be in a valid format\n\t044005\tCluster name is already used\n\t046101\tInvalid vector search configuration\n\t046102\tVector search is already installed\n\t046103\tVector search is not supported on this cluster\n\t046104\tInvalid instance type for vector search\n\t046105\tOnly one vector search instance is allowed per availability zone\n\t046106\tAt least one node is required for vector search to operate\n\t046107\tToo many vector search nodes specified for the rack\n\t046108\tInvalid rack specified\n\t050101\tError running health checks\n\t060101\tGeneral error\n\t060102\tAgents need to use the ZenDesk portal\n\t070101\tError listing the cloud accounts\n\t070201\tError creating a new cloud account\n\t070203\tInvalid request format\n\t070204\tUnsupported CloudProviderID\n\t070301\tError deleting the cloud accounts\n\t070303\tThe cloud account is used by one or more cluster DC\n\t070401\tError updating the cloud account\n\t070403\tCloudRoleExternalID must match the existing value\n\t070404\tBoundaryPolicyARN field AccountID must match AWSAccountID\n\t070405\tCloudPolicyARN field AccountID must match AWSAccountID\n\t070406\tCloudRoleARN field AccountID must match AWSAccountID\n\t070407\tAWSAccountID must be a valid 12-digit account ID or be empty\n\t070408\tBoundaryPolicyARN must be a valid ARN or be empty\n\t070409\tBoundaryPolicyARN must be a policy\n\t070410\tCloudPolicyARN must be a valid ARN or be empty\n\t070411\tCloudPolicyARN must be a policy\n\t070412\tCloudRoleARN must be a valid ARN or be empty\n\t070413\tCloudRoleARN must be a role\n\t070414\tThe cloud account is used by one or more cluster DC\n\t070501\tError getting the AWS boundary IAM policy document\n\t070601\tError getting the AWS cloud IAM policy document\n\t070603\tInvalid request format\n\t070604\tCloud policy name must be between 1 and 64 characters, and use only word characters or symbols: +=,./@-\n\t070605\tUnsupported cloud provider\n\t070606\tThe boundary policy ARN is not set\n\t070607\tThe AWS account ID is not set\n\t070701\tError checking the cloud account policies\n\t070703\tThe cloud account properties are not complete\n\t070801\tError getting the cloud account clusters\n\t070901\tThe cloud account was not found\n\t070902\tThe cloud account is invalid\n\t070903\tFailed to parse query parameter\n\t080001\tAt least one of properties clusterVPCID or clusterDCID have to be specified\n\t080002\tInvalid request format\n\t080003\tFirewall rule already exist\n\t080004\tCan't find target VPC\n\t080005\tCan't find target VPC\n\t080006\tUnknown cluster connection type\n\t080007\tProperty cidrlist is empty list\n\t080008\tProvided CIDRs overlaps reserved networks\n\t080009\tProvided CIDRs overlaps existing cluster datacenter CIDR\n\t080010\tProperty data.ramARN validation failed\n\t080011\tProperty data.tgwID validation failed\n\t080012\tProperty data.customerVPCID validation failed\n\t080013\tProperty data.customerAccountID validation failed\n\t080014\tProperty data.customerNetworkID validation failed\n\t080015\tInvalid request format\n\t080016\tInvalid firewall rule\n\t080017\tCIDR range is too big, the prefix must be at least /16\n\t080018\tInvalid request parameter\n\t080019\tProperty name validation failed\n\t080020\tGeneral error creating cluster connections\n\t080021\tProperty cidrlist can't have more than 5 entries\n\t081001\tFailed to parse query parameter type\n\t081002\tFailed to parse query parameter cluster-id\n\t081003\tFailed to parse query parameter dc-id\n\t081004\tFailed to parse query parameter vpc-id\n\t081005\tGeneral error listing cluster connections\n\t082001\tFailed to parse connection\n\t082002\tCluster connection not found\n\t082003\tGeneral error getting cluster connection\n\t083001\tFailed to parse connection\n\t083002\tCluster connection not found\n\t083003\tGeneral error deleting cluster connection\n\t084001\tFailed to parse connection\n\t084002\tCluster connection not found\n\t084003\tProperty cidrlist is empty list\n\t084004\tProvided CIDRs overlaps reserved networks\n\t084005\tProvided CIDRs overlaps existing cluster datacenter CIDR\n\t084006\tProperty data.ramARN validation failed\n\t084007\tProperty data.tgwID validation failed\n\t084008\tProperty data.customerVPCID validation failed\n\t084009\tProperty data.customerAccountID validation failed\n\t084010\tProperty data.customerNetworkID validation failed\n\t084011\tProperty name validation failed\n\t084012\tProperty status validation failed\n\t084013\tInvalid request format\n\t084014\tInvalid request format\n\t084015\tGeneral error updating cluster connection\n\t084016\tProperty cidrlist can't have more than 5 entries\n\t084017\tCan't recreate deleted cluster connection\n\t084018\tCluster connection has wrong status\n\t085001\tFailed to parse connection\n\t085002\tCluster connection not found\n\t085003\tProperty cidrlist is empty list\n\t085004\tProvided CIDRs overlaps reserved networks\n\t085005\tProvided CIDRs overlaps existing cluster datacenter CIDR\n\t085006\tProperty data.ramARN validation failed\n\t085007\tProperty data.tgwID validation failed\n\t085008\tProperty data.customerVPCID validation failed\n\t085009\tProperty data.customerAccountID validation failed\n\t085010\tProperty data.customerNetworkID validation failed\n\t085011\tProperty name validation failed\n\t085012\tConnection has unexpected status\n\t085013\tInvalid request format\n\t085014\tInvalid request format\n\t085015\tGeneral error updating cluster connection\n\t085016\tProperty cidrlist can't have more than 5 entries\n\t090101\tinvalid target filter\n\tBILLING_TOKEN\tThere was an error submitting your billing information\n"},"servers":[{"url":"/"}],"security":[{"Authorization":[]}],"paths":{"/deployment/cloud-providers":{"get":{"operationId":"getCloudProviders","summary":"Get list of supported cloud providers","description":"Lists details about all cloud provider currently supported in Scylla-Cloud.","x-public":true,"tags":["Deployment"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"040101"},"data":{"properties":{"cloudProviders":{"type":"array","items":{"$ref":"#/components/schemas/cloudProvider"}}},"required":["cloudProviders"]}}}}}}}}},"/pricing":{"post":{"operationId":"searchPricing","summary":"Search pricing","description":"Searches for pricing items based on infrastructure, product, and commercial filters","x-public":true,"tags":["Pricing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["infrastructure"],"properties":{"infrastructure":{"type":"object","required":["provider"],"properties":{"provider":{"type":"string","example":"AWS"},"region":{"type":"string","description":"Resolves region by code (e.g. \"us-east-1\") or display name (e.g. \"Virginia\")","example":"us-east-1"},"deployment":{"type":"string","enum":["Cloud","BYOA"]},"instanceFamily":{"type":"string","example":"i4i"},"instanceType":{"type":"string","example":"i4i.large"}}},"product":{"type":"object","properties":{"productTypes":{"type":"array","items":{"type":"string","enum":["STANDARD_CLOUD","XCLOUD","VECTOR_SEARCH"]}}}},"commercial":{"type":"object","properties":{"contractType":{"type":"string","enum":["ON_DEMAND","SUBSCRIPTION","FLEX_CREDIT"]},"contractTerm":{"type":"string","enum":["1_YEAR","3_YEARS","ANY"]},"paymentOption":{"type":"string","enum":["UPFRONT","MONTHLY","CONSUMPTION","ANY"]},"subscriptionTier":{"type":"string","enum":["STANDARD","PRO","PREMIUM","ANY"]}}},"pagination":{"type":"object","properties":{"page":{"type":"integer","format":"int64","minimum":1},"limit":{"type":"integer","format":"int64","minimum":1}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"skuId":{"type":"string","description":"Unique ID for Cart/Billing"},"infrastructure":{"type":"object","properties":{"provider":{"type":"string"},"region":{"type":"string"},"instanceType":{"type":"string"},"vcpu":{"type":"integer"},"storageTb":{"type":"number","format":"double"},"instanceFamily":{"type":"string"},"deployment":{"type":"string","enum":["Cloud","BYOA"]}}},"product":{"type":"object","properties":{"productType":{"type":"string","enum":["STANDARD_CLOUD","XCLOUD","VECTOR_SEARCH"]}}},"commercial":{"type":"object","properties":{"contractType":{"type":"string","enum":["ON_DEMAND","SUBSCRIPTION","FLEX_CREDIT"]},"contractTerm":{"type":"string","enum":["1_YEAR","3_YEARS","ANY"]},"paymentOption":{"type":"string","enum":["UPFRONT","MONTHLY","CONSUMPTION","ANY"]},"subscriptionTier":{"type":"string","enum":["STANDARD","PRO","PREMIUM","ANY"]}}},"pricing":{"type":"object","properties":{"currencyCode":{"type":"string"},"estimates":{"type":"array","items":{"type":"object","properties":{"intervalCode":{"type":"string","description":"ISO 8601 duration, e.g. \"PT1H\", \"P1M\", \"P3Y\""},"displayLabel":{"type":"string","description":"e.g. \"Hourly\", \"3 Year Total\""},"totalAmount":{"type":"number","format":"double"},"softwareAmount":{"type":"number","format":"double"},"hardwareAmount":{"type":"number","format":"double"},"vcpuSoftwareAmount":{"type":"number","format":"double"},"storageSoftwareAmount":{"type":"number","format":"double"}}}}}}}}},"pagination":{"type":"object","properties":{"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}}}}}}}}}}},"/account/{accountId}/cloud-account":{"get":{"operationId":"getCloudAccount","description":"Returns list of active cloud-accounts for all cloud-providers from given account","summary":"Get the list of active cloud-accounts","x-public":true,"tags":["Account"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CloudAccount"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}}},"/account/{accountId}/cloud-account/{cloudAccountId}/region/{regionId}/zones":{"get":{"operationId":"getCloudAccountZones","description":"Returns list of availability zones for a specific cloud account and region","summary":"Get availability zones for a cloud account and region","x-public":true,"tags":["Account"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"description":"CloudAccountId","in":"path","name":"cloudAccountId","required":true,"schema":{"type":"string"}},{"description":"RegionId","in":"path","name":"regionId","required":true,"schema":{"type":"string"}},{"description":"Instance Type ID to filter available zones","in":"query","name":"instanceTypeId","required":false,"schema":{"type":"string"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the availability zone","example":"use1-az2"},"name":{"type":"string","description":"Name of the availability zone","example":"us-east-1a"}}}}}}}}}}}},"/account/{accountId}/cluster/{clusterId}/request":{"get":{"operationId":"getClusterRequests","description":"Return the list of cluster requests created in the context of a given account.","summary":"Get the list of cluster requests created in context of given account","x-public":true,"tags":["Cluster Request"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"description":"type of request","in":"query","name":"type","schema":{"type":"string","enum":["ADD_DC","CREATE_CLUSTER","DELETE_CLUSTER","RESIZE_CLUSTER_V2","RESIZE_CLUSTER_V3","UPGRADE_CLUSTER","SCALE_CLUSTER","INSTALL_MANAGER","DNS","CREATE_VPC_PEERING","DELETE_VPC_PEERING","CREATE_CLUSTER_CONNECTION","DELETE_CLUSTER_CONNECTION","UPDATE_CLUSTER_CONNECTION","INSTALL_VECTOR_SEARCH","RESIZE_VECTOR_SEARCH","DELETE_VECTOR_SEARCH"]}},{"description":"status of request","in":"query","name":"status","schema":{"type":"string","enum":["QUEUED","IN_PROGRESS","FAILED","COMPLETED"]}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClusterRequest"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}}},"/account/{accountId}/cluster/request/{requestId}":{"get":{"operationId":"getClusterRequestById","description":"Return details about a particular cluster request.","summary":"Get the details about cluster request","x-public":true,"tags":["Cluster Request"],"parameters":[{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"header","name":"traceparent","schema":{"type":"string"}},{"description":"RequestId","in":"path","name":"requestId","required":true,"schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"$ref":"#/components/schemas/ClusterRequest"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}}},"/account/{accountId}/clusters":{"get":{"operationId":"getClusters","summary":"Get the list of all clusters belonging to given account","description":"Returns list of all clusters belonging to given account.","x-public":true,"tags":["Cluster"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"query","description":"Enrich cluster with additional data (provider, region, instance)","name":"enriched","required":false,"schema":{"type":"boolean"}},{"in":"query","description":"Get cluster with metrics data - list of comma separated metrics to fetch","name":"metrics","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/MetricName"}},"style":"form","explode":false,"example":["NODES_UP","STORAGE_FREE","STORAGE_USED"]}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"clusters":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ClusterInfo"},{"$ref":"#/components/schemas/ClusterEnriched"},{"$ref":"#/components/schemas/ClusterWithMetrics"}]}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}}},"/account/{accountId}/cluster/{clusterId}/delete":{"post":{"operationId":"deleteCluster","description":"Delete cluster (async)","x-public":true,"summary":"Delete cluster (async)","tags":["Cluster"],"parameters":[{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"header","name":"traceparent","schema":{"type":"string"}}],"requestBody":{"description":"name of the cluster","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"clusterName":{"type":"string"}}}}}},"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"$ref":"#/components/schemas/ClusterRequest"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}}},"/account/{accountId}/cluster/{clusterId}/resize":{"post":{"operationId":"resizeCluster","description":"create cluster resize request (async)","x-public":true,"summary":"Resize cluster (async)","tags":["Cluster"],"parameters":[{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"header","name":"traceparent","schema":{"type":"string"}}],"requestBody":{"description":"cluster-resize request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterResizeRequest"}}}},"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"$ref":"#/components/schemas/ClusterResizeResponse"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}}},"/account/{accountId}/cluster/{clusterId}/dc/{dcId}/scaling":{"put":{"operationId":"updateDcScalingPolicy","summary":"Update datacenter scaling policy","description":"Updates the scaling policy configuration for a specific datacenter including instance types, families, and scaling policies","x-public":true,"tags":["Cluster"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"name":"dcId","in":"path","description":"ID of the datacenter","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"instanceTypeIDs":{"type":"array","items":{"type":"integer"}},"instanceFamilies":{"type":"array","items":{"type":"string"}},"policies":{"$ref":"#/components/schemas/APIDCScalingPolicies"}}}}}},"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK - Scaling policy updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ClusterRequest"},"error":{"type":"string"}}}}}}}}},"/account/{accountId}/cluster":{"post":{"operationId":"createCluster","description":"Create a cluster-create request (async).","x-public":true,"summary":"Create cluster-create request (async)","tags":["Cluster"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"cluster-create request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterCreateRequestV1"}}}},"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"properties":{"requestId":{"type":"string"},"fields":{"$ref":"#/components/schemas/ClusterCreateResponse"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}}},"/account/{accountId}/cluster/{clusterId}":{"get":{"operationId":"getClusterDetails","summary":"Get cluster details","description":"Get full details of a specific cluster.","x-public":true,"tags":["Cluster"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"query","description":"Enrich cluster with additional data","name":"enriched","required":false,"schema":{"type":"boolean"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"properties":{"cluster":{"$ref":"#/components/schemas/ClusterDetailedInfo"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}}},"/account/{accountId}/cluster/{clusterId}/nodes":{"get":{"operationId":"getClusterNodes","summary":"Get cluster nodes","description":"Get the list of cluster nodes.","x-public":true,"tags":["Cluster"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"query","description":"Enrich nodes with additional data","name":"enriched","required":false,"schema":{"type":"boolean"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"nodes":{"type":"array","items":{"$ref":"#/components/schemas/NodeInfoEnriched"}}}}}}}}}}}},"/account/{accountId}/cluster/{clusterId}/dcs":{"get":{"operationId":"getClusterDCs","summary":"Get cluster data centers","description":"Get the list of data centers used by a cluster.","x-public":true,"tags":["Cluster"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"query","description":"Enrich DCs with additional data","name":"enriched","required":false,"schema":{"type":"boolean"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"dataCenters":{"type":"array","items":{"$ref":"#/components/schemas/ClusterDCInfoEnriched"}}}}}}}}}}}},"/account/{accountId}/cluster/{clusterId}/network/firewall/allowed":{"post":{"operationId":"createFirewallAllowedRule","summary":"Create a new firewall allowed rule","description":"Create a new firewall allowed rule.","x-public":true,"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"ipAddress and CIDR block","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ipAddress":{"type":"string"}}}}}},"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FirewallRules"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}},"tags":["Account Cluster Network"]},"get":{"operationId":"getFirewallAllowedRules","summary":"Get the cluster firewall rules","description":"List the cluster firewall rules.","x-public":true,"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FirewallRules"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}},"tags":["Account Cluster Network"]}},"/account/{accountId}/cluster/{clusterId}/network/firewall/allowed/{ruleId}":{"delete":{"operationId":"deleteFirewallAllowedRule","summary":"Delete the firewall rule of given id","description":"Delete the firewall rule of a given id.","x-public":true,"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"description":"Rule ID","in":"path","name":"ruleId","required":true,"schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FirewallRules"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}},"tags":["Account Cluster Network"]}},"/account/{accountId}/cluster/{clusterId}/name":{"patch":{"operationId":"updateClusterName","summary":"Update cluster name (async).","x-public":true,"description":"Update cluster name.","parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"new cluster name","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}}},"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterRequest"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}},"tags":["Cluster"]}},"/account/{accountId}/cluster/{clusterId}/network/vpc/connection":{"get":{"operationId":"getConnections","description":"Lists details of all connection","x-public":true,"parameters":[{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"description":"List of connection types","in":"query","name":"type","schema":{"type":"string"}},{"description":"Datacenter ID","in":"query","name":"dc","schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClusterConnection"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}},"summary":"get the list of all connection","tags":["Account network cluster connection"]},"post":{"operationId":"createConnection","description":"Creates connection according to given request payload","x-public":true,"parameters":[{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Cluster connection request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cidrList":{"description":"CIDRList IPv4 networks to be accessible through this connection","items":{"$ref":"#/components/schemas/CIDR","type":"array"}},"clusterDCID":{"type":"integer"},"data":{"type":"object","properties":{"ramARN":{"description":"AWS arn of the RAM","type":"string","example":"arn:aws:ram:us-east-1:123456789012:resource-share/12345678-1234-1234-1234-123456789012"},"tgwID":{"description":"ID of the TGW connection","type":"string","example":"tgw-12345678901234567"}}},"name":{"description":"Name is the connection, only to show on UI","type":"string"},"type":{"enum":["AWS_TGW_ATTACHMENT"],"type":"string"}}}}}},"security":[{"Authorization":[]}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ClusterRequest"},{"type":"object","properties":{"connectionID":{"type":"integer","description":"Connection ID that was created"}}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}},"summary":"creates connection according to given request payload","tags":["Account network cluster connection"]}},"/account/{accountId}/cluster/{clusterId}/network/vpc/connection/{connectionId}":{"get":{"operationId":"getConnection","description":"Get connection details","x-public":true,"parameters":[{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Connection ID","name":"connectionId","required":true,"schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"$ref":"#/components/schemas/ClusterConnection"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}},"summary":"get cluster connection details","tags":["Account network cluster connection"]},"patch":{"operationId":"updateConnection","description":"Updates connection according to given request payload","x-public":true,"parameters":[{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Connection ID","name":"connectionId","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Cluster connection request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cidrList":{"description":"CIDRList IPv4 networks to be accessible through this connection","items":{"$ref":"#/components/schemas/CIDR"},"type":"array"},"name":{"description":"Name is the connection, only to show on UI","type":"string"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"}}}}}},"security":[{"Authorization":[]}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"$ref":"#/components/schemas/ClusterConnection"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}},"summary":"Updates connection according to given request payload","tags":["Account network cluster connection"]},"put":{"operationId":"recreateConnection","description":"Recreates cloud objects related to connection according to given request payload. Updates ExternalID at the end","x-public":true,"parameters":[{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Connection ID","name":"connectionId","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Cluster connection request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cidrList":{"description":"CIDRList IPv4 networks to be accessible through this connection","items":{"$ref":"#/components/schemas/CIDR"},"type":"array"},"data":{"type":"object","properties":{"ramARN":{"description":"AWS arn of the RAM","type":"string","example":"arn:aws:ram:us-east-1:123456789012:resource-share/12345678-1234-1234-1234-123456789012"},"tgwID":{"description":"ID of the TGW connection","type":"string","example":"tgw-12345678901234567"}}},"name":{"description":"Name is the connection, only to show on UI","type":"string"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"}}}}}},"security":[{"Authorization":[]}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterRequest"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}},"summary":"Updates connection according to given request payload","tags":["Account network cluster connection"]},"delete":{"description":"Deletes the connection","operationId":"deleteConnection","x-public":true,"parameters":[{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Connection ID","name":"connectionId","required":true,"schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterRequest"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}},"summary":"deletes the connection","tags":["Account network cluster connection"]}},"/account/{accountId}/cluster/{clusterId}/notifications/email":{"post":{"operationId":"setClusterNotificationEmail","summary":"Set cluster notification emails","description":"Set the contact email address(es) used for cluster notifications","x-public":true,"tags":["Account","Cluster"],"parameters":[{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["emails"],"properties":{"emails":{"items":{"type":"string"},"type":"array","example":["notifications@achme.com","other@mail.com"]}}}}}},"security":[{"Authorization":[]}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"$ref":"#/components/schemas/NotificationEmail"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"integer"}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error"},"502":{"description":"Bad Gateway"}}}},"/account/default":{"get":{"operationId":"getAccount","description":"Gives account details tied to authorized user.","x-public":true,"summary":"Gives account details tied to authorized user","tags":["Account"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"$ref":"#/components/schemas/Account"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}}},"/account/{accountId}/notifications/email":{"get":{"operationId":"getNotificationsEmail","summary":"Get cluster notification emails","description":"Get the contact email address(es) used for cluster notifications","x-public":true,"tags":["Account"],"parameters":[{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"$ref":"#/components/schemas/NotificationEmail"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}},"post":{"operationId":"setNotificationEmail","summary":"Set cluster notification emails","description":"Set the contact email address(es) used for cluster notifications","x-public":true,"tags":["Account"],"parameters":[{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["emails"],"properties":{"emails":{"items":{"type":"string"},"type":"array","example":["notifications@achme.com","other@mail.com"]}}}}}},"security":[{"Authorization":[]}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"$ref":"#/components/schemas/NotificationEmail"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"integer"}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error"},"502":{"description":"Bad Gateway"}}}},"/account/{accountId}/cluster/{clusterId}/dc/{dcId}/vector-search":{"post":{"operationId":"installVectorSearch","description":"Schedules addition of vector search nodes to the specified datacenter in the cluster (async).","summary":"Install vector search nodes to the specified datacenter in the cluster (async)","x-public":true,"tags":["VectorSearch"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Datacenter ID","name":"dcId","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Parameters for adding vector search nodes","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorSearchRequest"}}}},"security":[{"Authorization":[]}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterRequest"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteVectorSearch","description":"Schedules deletion of vector search nodes from the specified datacenter in the cluster (async)","summary":"Delete vector search nodes from the specified datacenter in the cluster (async)","x-public":true,"tags":["VectorSearch"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Datacenter ID","name":"dcId","required":true,"schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterRequest"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}},"get":{"operationId":"getVectorSearchInfo","description":"Retrieves information about vector search nodes in the specified datacenter in the cluster","summary":"Get information about vector search nodes in the specified datacenter in the cluster","x-public":true,"tags":["VectorSearch"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Datacenter ID","name":"dcId","required":true,"schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorSearchInfo"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}},"patch":{"operationId":"resizeVectorSearch","description":"Schedules resizing of vector search nodes in the specified datacenter in the cluster (async)","summary":"Resize vector search nodes in the specified datacenter in the cluster (async)","x-public":true,"tags":["VectorSearch"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Datacenter ID","name":"dcId","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Parameters for resizing vector search nodes","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorSearchRequest"}}}},"security":[{"Authorization":[]}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterRequest"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}}},"/account/{accountId}/cluster/{clusterId}/network/vpc/peer":{"get":{"operationId":"getVPCPeeringList","summary":"Get the details of all cluster VPC peers","description":"List the details of all cluster VPC peers.","x-public":true,"tags":["Account Cluster Network"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClusterVPCPeeringInfo"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}},"post":{"operationId":"createVPCPeering","summary":"Create VPC peering according to given request payload","description":"Create VPC peering according to a given request payload.","x-public":true,"tags":["Account Cluster Network"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"query","description":"Run the request in an asynchronous mode","name":"async","required":false,"schema":{"type":"boolean"}}],"requestBody":{"description":"Peering details","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cidrBlock":{"type":"string","description":"Single address or list of comma separated CIDR block addresses,","example":"10.10.0.0/16"},"dcId":{"type":"integer"},"vpcId":{"type":"string"},"ownerId":{"type":"string"},"regionId":{"description":"Applicable to AWS only,","type":"integer"},"allowCql":{"type":"boolean"}}}}}},"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"type":"object","properties":{"externalId":{"type":"string"},"id":{"type":"integer"},"requestId":{"type":"integer"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}}},"/account/{accountId}/cluster/{clusterId}/network/vpc/peer/{peerId}":{"get":{"operationId":"getVPCPeeringInfo","summary":"Get the details of VPC peer","description":"List the details of cluster VPC peer.","x-public":true,"tags":["Account Cluster Network"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Peer ID","name":"peerId","required":true,"schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"$ref":"#/components/schemas/ClusterVPCPeeringInfo"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateVPCPeering","summary":"Updates VPC peering according to given request payload","description":"Updates VPC peering according to given request payload.","x-public":true,"tags":["Account Cluster Network"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Peer ID","name":"peerId","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Peering details","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Can be \"ACTIVE\" or \"INACTIVE\", triggers peering to switch to desired state","example":"ACTIVE"},"cidrBlock":{"type":"string","description":"Single address or list of comma separated CIDR block addresses,","example":"10.10.0.0/16"}}}}}},"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterVPCPeeringInfo"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteVPCPeering","summary":"Schedule delete VPC peering request (async)","description":"Schedule delete VPC peering request (async). Returns a cluster request","x-public":true,"tags":["Account Cluster Network"],"parameters":[{"in":"header","name":"traceparent","schema":{"type":"string"}},{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},{"in":"path","description":"Peer ID","name":"peerId","required":true,"schema":{"type":"integer"}}],"security":[{"Authorization":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"data":{"$ref":"#/components/schemas/ClusterRequest"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error"}}}},"/deployment/scylla-versions":{"get":{"operationId":"getScyllaVersions","summary":"Get all scylla cloud versions","description":"List all available ScyllaDB Cloud service versions.","x-public":true,"tags":["Deployment"],"parameters":[{"in":"query","description":"Should include default values","name":"defaults","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"040101"},"data":{"properties":{"defaultScyllaVersionId":{"type":"integer","example":91},"scyllaVersions":{"type":"array","items":{"$ref":"#/components/schemas/scyllaVersion"}}},"required":["scyllaVersions"]}}}}}}}}},"/deployment/cloud-provider/{cloudProviderId}/regions":{"get":{"operationId":"getCloudProviderRegions","summary":"Get all regions for the cloud provider","description":"Lists regions supported by the given cloud provider ID.","x-public":true,"tags":["Deployment"],"parameters":[{"in":"path","description":"Cloud Provider ID (full list [get] /deployment/provider)","name":"cloudProviderId","required":true,"schema":{"type":"integer","example":1}},{"in":"query","description":"Should include default values","name":"defaults","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/errorObject"},{"type":"object","properties":{"data":{"properties":{"regions":{"type":"array","items":{"$ref":"#/components/schemas/region"}},"defaultRegionId":{"type":"integer","example":30},"defaultInstanceId":{"type":"integer","example":40},"instances":{"type":"array","items":{"$ref":"#/components/schemas/instance"}}},"required":["regions"]}}}]}}}}}}},"/deployment/cloud-provider/{cloudProviderId}/region/{regionId}":{"get":{"operationId":"getCloudProviderRegion","summary":"Get all instances for the selected region","description":"Lists instances supported in given region of given cloud provider.","x-public":true,"tags":["Deployment"],"parameters":[{"in":"path","description":"Cloud Provider ID (full list [get] /deployment/provider)","name":"cloudProviderId","required":true,"schema":{"type":"integer","example":1}},{"in":"path","description":"Cloud Region ID (full list [get] /deployment/provider/{}/region)","name":"regionId","required":true,"schema":{"type":"integer","example":30}},{"in":"query","description":"Should include default values","name":"defaults","required":false,"schema":{"type":"boolean","default":false}},{"description":"target for the requested instance types","in":"query","name":"target","schema":{"type":"string","enum":["VECTOR_SEARCH"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"040101"},"data":{"properties":{"defaultInstanceId":{"type":"integer","example":1},"instances":{"type":"array","items":{"$ref":"#/components/schemas/instance"}}},"required":["instances"]}}}}}}}}}},"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer","description":"Authorization header, required in all authenticated requests.\n\nHeader format: **Authorization: Bearer <token>**\n"}},"schemas":{"ClusterConnection":{"type":"object","description":"Peering details information","x-public":true,"properties":{"awaitingData":{"allOf":[{"type":"object"},{"$ref":"#/components/schemas/ClusterConnectionAwaitingData"}],"description":"AwaitingData represents information regarding the action that needs to be done to move connection creating process further"},"awaitingForClient":{"type":"boolean","description":"AwaitingForClient if true, then going to next stage require user action"},"cidrlist":{"type":"array","description":"CIDR list of the routes cluster have access through this connection","items":{"$ref":"#/components/schemas/CIDR"}},"clusterDCID":{"type":"integer","description":"ID of the cluster DC"},"clusterID":{"type":"integer","description":"ID of the cluster"},"clusterVPCID":{"type":"integer","description":"ID of the VPC"},"data":{"type":"object","additionalProperties":{"type":"string"}},"externalID":{"type":"string","description":"ExternalID and ID of the connection object on the cloud"},"id":{"type":"integer","description":"ID of the created connection (ScyllaDB internal)"},"name":{"type":"string","description":"Name if the connection, only to show on UI"},"stage":{"type":"string","description":"Stage if there is ongoing process it shows where this process exactly at"},"stageMessage":{"type":"string","description":"StageMessage is a message from stage processor why it can't move further"},"status":{"type":"string","enum":["INIT","PENDING","ACTIVE","INACTIVE","DELETING","DELETED","FAILED"]},"type":{"type":"string","enum":["AWS_TGW_ATTACHMENT"]}}},"ClusterInfo":{"type":"object","description":"Information about the cluster","x-public":true,"properties":{"id":{"type":"integer","description":"ID of the cluster"},"accountId":{"type":"integer","description":"ID of the account where cluster belongs to"},"clusterName":{"type":"string","description":"Name of the cluster"},"scalingMode":{"type":"object","description":"Scaling mode of the cluster.","properties":{"mode":{"$ref":"#/components/schemas/ScalingMode"}}},"status":{"type":"string","description":"Status of the cluster","enum":["ACTIVE","QUEUED","BOOTSTRAPPING","BOOTSTRAP_ERROR","INACTIVE","PENDING_DELETE","DELETED"]},"cloudProviderId":{"type":"integer","description":"ID of the cloud provider (full list [get] /deployment/cloud-providers)"},"encryptionAtRest":{"$ref":"#/components/schemas/EncryptionAtRest","description":"Encryption at rest info for this cluster\nSpecifies the key id and provider\nEmpty if the cluster does not use the encryption-at-rest feature"},"encryptionMode":{"description":"Defines how the client can connect to the cluster using CQL.","type":"string"},"encryptionCertificateMode":{"description":"EncryptionCertificateMode when client connection is encrypted this property indicates if Cluster CA was signed with Account CA","type":"string"},"userApiInterface":{"type":"string","description":"CQL or ALTERNATOR (DynamoDB)","enum":["CQL","ALTERNATOR"]},"deals":{"type":"array","description":"deals in use of the cluster","items":{"$ref":"#/components/schemas/DealsInUse"}},"isLocked":{"type":"boolean","description":"Indicates whether the cluster is currently locked due to an ongoing operation"},"pricingModel":{"type":"integer","description":"Defines the pricing model"},"maxAllowedCIDRRange":{"type":"integer","description":"Max CIDR range the user is allowed to specify on allowed ips rules, 0 disable all limitations."},"dns":{"type":"boolean","description":"DNS enabled flag"},"dcCount":{"type":"integer","description":"Number of Data Centers"},"dc":{"$ref":"#/components/schemas/ClusterDCInfo"},"provisioning":{"$ref":"#/components/schemas/ProvisionType"},"alternatorWriteIsolation":{"type":"string","description":"Write isolation for ALTERNATOR","enum":["","forbid","only_rmw_uses_lwt","always"]},"expiresAt":{"type":"string"},"progress":{"$ref":"#/components/schemas/ClusterRequestProgress"},"accountCloudProviderCredentialsId":{"type":"integer","description":"ID of the account credentials"},"requestError":{"type":"string","description":"Descriptive information about the potential error"},"scyllaVersion":{"$ref":"#/components/schemas/scyllaVersion"}},"required":["id","accountId","clusterName","status","cloudProviderId","scyllaVersion"]},"ClusterEnriched":{"x-public":true,"allOf":[{"$ref":"#/components/schemas/ClusterInfo"},{"type":"object","properties":{"scyllaVersion":{"$ref":"#/components/schemas/scyllaVersion"},"cloudProvider":{"$ref":"#/components/schemas/cloudProvider"},"regionId":{"type":"integer","description":"ID of the cloud provider region (full list [get] /deployment/cloud-provider/{}/regions)"},"region":{"$ref":"#/components/schemas/region"},"instanceId":{"type":"integer","description":"ID of the instance type"},"instance":{"$ref":"#/components/schemas/instance"}}}]},"ClusterWithMetrics":{"x-public":true,"allOf":[{"$ref":"#/components/schemas/ClusterInfo"},{"type":"object","properties":{"instanceId":{"type":"integer","description":"ID of the instance type"},"metrics":{"type":"object","additionalProperties":{"type":"number","description":"Map of cluster metrics [metric_name | value]"}}}}]},"ClusterDetailedInfo":{"x-public":true,"allOf":[{"$ref":"#/components/schemas/ClusterEnriched"},{"type":"object","properties":{"replicationFactor":{"type":"integer","description":"Replication Factor (RF)"},"broadcastType":{"type":"string","description":"Broadcast type","enum":["PRIVATE","PUBLIC"]},"grafanaUrl":{"type":"string","description":"URL of grafana (part of Monitoring Stack)"},"createdAt":{"type":"string","description":"Creation date","format":"date-time"},"promProxyEnabled":{"type":"boolean","description":"Prometheus proxy enabled flag"},"rebootEnabled":{"type":"boolean","description":"Determines if node reboot is enabled"},"clientIp":{"type":"string"},"allowedIps":{"type":"array","description":"List of CIDR formatted rules a.b.c.d/e","items":{"$ref":"#/components/schemas/FirewallRule"}},"dataCenters":{"type":"array","items":{"$ref":"#/components/schemas/ClusterDCInfoEnriched"}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/NodeInfoEnriched"}},"vpcList":{"type":"array","items":{"$ref":"#/components/schemas/ClusterNetwork"}},"vpcPeeringList":{"type":"array","items":{"$ref":"#/components/schemas/ClusterVPCPeeringInfo"}},"connections":{"type":"array","items":{"$ref":"#/components/schemas/ClusterConnection"}}}}]},"EncryptionAtRest":{"type":"object","x-public":true,"properties":{"keyId":{"type":"string","description":"Provide the ID of the customer-managed key created in the ScyllaDB Cloud portal.\nOmit this item to allow ScyllaDB Cloud to automatically create a service-managed key.","example":"key-deadbeef"},"provider":{"type":"string","description":"key provider, customer managed or scylla managed","enum":["scylla-aws","scylla-gcp","aws","gcp"],"example":"scylla-aws"}}},"VectorSearch":{"type":"object","x-public":true,"properties":{"nodeCount":{"description":"Number of vector search nodes to create in the datacenter, nodes are distributed evenly across cluster racks","type":"integer","example":2,"minimum":1,"maximum":27},"defaultInstanceTypeId":{"type":"integer","description":"ID of the instance type to use for vector search nodes (instance type list [get] /deployment/cloud-provider/{}/region/{}?target=VECTOR_SEARCH)"}}},"ClusterDCInfo":{"type":"object","x-public":true,"properties":{"id":{"type":"integer","description":"ID of the datacenter"},"clusterId":{"type":"integer","description":"ID of the cluster where the datacenter belongs to"},"cloudProviderId":{"type":"integer","description":"ID of the cloud provider (full list [get] /deployment/cloud-providers)"},"regionId":{"type":"integer","description":"ID of the cloud provider region (full list [get] /deployment/cloud-provider/{}/regions)"},"replicationFactor":{"type":"integer","description":"Replication Factor (RF)"},"cidrBlock":{"$ref":"#/components/schemas/CIDR"},"accountCloudProviderCredentialsId":{"type":"integer","description":"ID of the account credentials"},"status":{"type":"string","description":"Status of the data center","enum":["ACTIVE","INIT","INACTIVE","DELETED","BOOTSTRAP_COMPLETE","BOOTSTRAP_ERROR","JOINING","JOINING_ERROR"]},"name":{"type":"string","description":"Name of the data center"},"instanceId":{"type":"integer","description":"ID of the instance type"},"scaling":{"allOf":[{"$ref":"#/components/schemas/APIDCScaling"}],"description":"Datacenter scaling information."}}},"ClusterDCInfoEnriched":{"x-public":true,"allOf":[{"$ref":"#/components/schemas/ClusterDCInfo"},{"type":"object","properties":{"cloudProvider":{"$ref":"#/components/schemas/cloudProvider"},"region":{"$ref":"#/components/schemas/region"}}}]},"NodeInfo":{"type":"object","x-public":true,"properties":{"azName":{"type":"string","description":"Name of the availability zone"},"azId":{"type":"string","description":"ID of the availability zone"},"rackName":{"type":"string","description":"Name of the rack"},"billingStartDate":{"type":"string","description":"Starting date for the billing"},"cloudProviderId":{"type":"integer","description":"ID of the cloud provider (full list [get] /deployment/cloud-providers)"},"instanceId":{"type":"integer","description":"ID of the instance type"},"regionId":{"type":"integer","description":"ID of the cloud provider region (full list [get] /deployment/cloud-providers/{}/regions)"},"dcId":{"type":"integer","description":"ID of the datacenter"},"clusterJoinDate":{"type":"string","description":"Date when server joined the cluster"},"dns":{"type":"string","description":"Server's DNS name"},"id":{"type":"integer","description":"ID of the node"},"state":{"type":"string","description":"Status of the node","enum":["NORMAL","JOINING","LEAVING","DECOMMISSIONED","MOVING","REMOVED"]},"privateIp":{"type":"string","description":"Private IP of the node"},"publicIp":{"type":"string","description":"Public IP of the node"},"serviceId":{"description":"Deprecated","type":"integer","deprecated":true},"serviceVersionId":{"description":"Deprecated","type":"integer","deprecated":true},"status":{"type":"string","description":"Status of the node","enum":["ACTIVE","INACTIVE","PENDING_DELETE","DELETED","QUEUED"]}}},"NodeInfoEnriched":{"x-public":true,"allOf":[{"$ref":"#/components/schemas/NodeInfo"},{"type":"object","properties":{"cloudProvider":{"$ref":"#/components/schemas/cloudProvider"},"region":{"$ref":"#/components/schemas/region"},"instance":{"$ref":"#/components/schemas/instance"},"dataCenter":{"$ref":"#/components/schemas/ClusterDCInfo"}}}]},"ClusterNetwork":{"type":"object","x-public":true,"properties":{"clusterId":{"type":"integer","description":"ID of the cluster where the datacenter belongs to"},"id":{"type":"integer","description":"ID of the VPC (internal for scylla-cloud)"},"cloudProviderId":{"type":"integer","description":"ID of the cloud provider (full list [get] /deployment/cloud-providers)"},"regionId":{"type":"integer","description":"ID of the cloud provider region (full list [get] /deployment/cloud-provider/{}/regions)"},"cidrBlock":{"$ref":"#/components/schemas/CIDR"}}},"ClusterRequestProgress":{"type":"object","x-public":true,"properties":{"progressPercent":{"type":"integer","description":"Request processing progress"},"progressDescription":{"type":"string","description":"Request progress description"}}},"ProvisionType":{"type":"string","enum":["dedicated-vm"],"default":"dedicated-vm","x-public":true,"description":"type of the cluster provisioning"},"CIDR":{"type":"string","description":"CIDR block in the form of ip/mask","x-public":true,"example":"192.0.2.0/24"},"FirewallRules":{"type":"object","description":"List of CIDR formatted rules a.b.c.d/e","x-public":true,"properties":{"clusterId":{"type":"integer","description":"ID of the cluster where the datacenter belongs to"},"id":{"type":"integer","description":"ID of the firewall allowed rule"},"address":{"$ref":"#/components/schemas/CIDR"}}},"ClusterVPCPeeringInfo":{"type":"object","x-public":true,"properties":{"externalId":{"type":"string","description":"External ID of the VPC peering","example":"pcx-21f1c5d76e55f2b0c"},"id":{"type":"integer","description":"ID of the VPC peering (scyllaDB internal)"},"networkName":{"type":"string","description":"Name of the network (GCP specific)"},"ownerId":{"type":"string","description":"Owner of the peering (AWS account ID or GCP project ID)"},"vpcId":{"type":"string","description":"Peer VPC external ID","example":"vpc-11f1c5d76e55f2b0c"},"cidrList":{"description":"List of CIDRs","items":{"$ref":"#/components/schemas/CIDR"},"type":"array"},"cidrBlockVerified":{"type":"array","description":"List of CIDRs","items":{"$ref":"#/components/schemas/CIDR"}},"regionId":{"type":"integer","description":"ID of the cloud provider region, returned for AWS clusters only (full list [get] /deployment/cloud-provider/{}/regions)"},"projectId":{"type":"string","description":"GCP Project ID (GCP specific)"},"status":{"type":"string","description":"Status of the VPC peering","enum":["INITIATING_REQUEST","PENDING_ACCEPTANCE","DELETING","DELETED","FAILED","REJECTED","EXPIRED","PROVISIONING","ACTIVE","MISMATCHED","INACTIVE"]},"expiresAt":{"type":"string","description":"Expiration time"},"allowCql":{"type":"boolean","description":"Is CQL connection allowed for peering CIDRs"},"dcId":{"description":"ID of the cluster's data center","type":"integer"}}},"ClusterCreateRequestV1":{"type":"object","x-public":true,"properties":{"accountCredentialId":{"type":"integer","description":"ID of the account credentials"},"alternatorWriteIsolation":{"type":"string","description":"Write isolation for ALTERNATOR","enum":["forbid","only_rmw_uses_lwt","always"]},"broadcastType":{"type":"string","description":"Broadcast type","enum":["PRIVATE","PUBLIC"]},"cidrBlock":{"$ref":"#/components/schemas/CIDR"},"cloudProviderId":{"type":"integer","description":"ID of the cloud provider (full list [get] /deployment/cloud-providers)"},"instanceId":{"type":"integer","description":"ID of the instance type"},"regionId":{"type":"integer","description":"ID of the cloud provider region (full list [get] /deployment/cloud-provider/{}/regions)"},"availabilityZoneIdsOverride":{"type":"array","description":"Forces the scylla node VMs to be deployed on these zones.\n\nFor AWS, these are AZ IDs (e.g., \"use1-az1\", \"use1-az2\").\nFor GCP, these are zone names (e.g., \"us-east1-b\").","items":{"type":"string"}},"placement":{"type":"string","enum":["true","false",""],"description":"Forces the ScyllaDB nodes to be deployed in the specified zones. You can specify any combination of valid Availability Zone ID identifiers (zone names for GCP). You can deploy all nodes in a single AZ by specifying the same AZ ID 3 times. Doing this requires setting placement to true","default":""},"enableDnsAssociation":{"type":"boolean","description":"Enables DNS on the cluster and creation of the DNS records for the seed nodes at cluster creation time","default":true},"allowedIPs":{"type":"array","description":"List of CIDR formatted rules a.b.c.d/e","items":{"$ref":"#/components/schemas/FirewallRule"}},"freeTier":{"type":"boolean","description":"Defines if the free-tier cluster should be created"},"clusterName":{"type":"string","description":"Name of the cluster"},"numberOfNodes":{"type":"integer","description":"Number of nodes"},"promProxy":{"type":"boolean","description":"Defines if prometheus proxy will be available"},"replicationFactor":{"type":"integer","description":"Replication Factor (RF)"},"scyllaVersion":{"type":"string","description":"Scylla Version to be installed","example":"2024.1.11"},"userApiInterface":{"type":"string","description":"CQL or ALTERNATOR (DynamoDB)","enum":["CQL","ALTERNATOR"]},"maintenanceWindows":{"type":"array","description":"MaintenanceWindows is the optional specification to enable maintenance windows. If empty, the default maintenance window will be used.","items":{"$ref":"#/components/schemas/ClusterMaintenanceWindow"},"minItems":2,"maxItems":4},"provisioning":{"type":"string","description":"Provisioning type for the cluster","default":"dedicated-vm","enum":["dedicated-vm"]},"pu":{"type":"integer","default":1,"maximum":1000,"minimum":1},"expiration":{"type":"string","example":"96h"},"encryptionAtRest":{"$ref":"#/components/schemas/EncryptionAtRest","description":"EncryptionAtRest is the optional specification to enable encryption-at-rest on the Scylla side.\nOne of Provider or KeyID field should be specified."},"scaling":{"allOf":[{"$ref":"#/components/schemas/APIDCScaling"}],"description":"Datacenter scaling information."},"vectorSearch":{"$ref":"#/components/schemas/VectorSearch","description":"VectorSearch is the optional specification to enable vector search capabilities for the Scylla cluster."}}},"ClusterCreateResponse":{"x-public":true,"allOf":[{"$ref":"#/components/schemas/ClusterCreateRequestV1"},{"type":"object","properties":{"cloudProvider":{"$ref":"#/components/schemas/cloudProvider"},"scyllaVersion":{"$ref":"#/components/schemas/scyllaVersion"},"region":{"$ref":"#/components/schemas/region"},"instance":{"$ref":"#/components/schemas/instance"}}}]},"DealsInUse":{"type":"object","x-public":true,"properties":{"expiresAt":{"type":"string"},"type":{"type":"string","description":"Type of the deal","enum":["FREE_TIER","JUMP_START"]}}},"ClusterNodeRebootPayload":{"x-public":true,"properties":{"nodeReboot":{"type":"boolean","description":"NodeReboot controls if it is allowed to do a node reboot for the cluster\nto simulate issues."}}},"NodeRebootRequest":{"type":"object","x-public":true,"properties":{"duration":{"description":"Duration is the number of seconds the node is supposed to be inactive.\nIt is an optional parameter, if not provided 300 sec is used.\nAllowed values range is 0..900."},"force":{"type":"boolean","description":"Force flag controls if force shutdown should be used to stop the node."}}},"ClusterRequest":{"type":"object","x-public":true,"properties":{"accountId":{"type":"integer","description":"ID of the account where cluster belongs to"},"clusterId":{"type":"integer","description":"ID of the cluster where the datacenter belongs to"},"connectionID":{"type":"integer"},"id":{"type":"integer","description":"ID of the cluster request"},"progressDescription":{"type":"string","description":"Request progress description"},"progressPercent":{"type":"integer","description":"Request processing progress"},"requestBody":{"type":"string","description":"JSON body of the request"},"requestType":{"type":"string","description":"Defines type of the request","enum":["ADD_DC","CREATE_CLUSTER","DELETE_CLUSTER","RESIZE_CLUSTER_V2","RESIZE_CLUSTER_V3","UPGRADE_CLUSTER","SCALE_CLUSTER","INSTALL_MANAGER","DNS","CREATE_VPC_PEERING","DELETE_VPC_PEERING","CREATE_CLUSTER_CONNECTION","DELETE_CLUSTER_CONNECTION","UPDATE_CLUSTER_CONNECTION","INSTALL_VECTOR_SEARCH","RESIZE_VECTOR_SEARCH","DELETE_VECTOR_SEARCH"]},"status":{"type":"string","description":"Status of the request","enum":["QUEUED","IN_PROGRESS","FAILED","COMPLETED","CANCELLED"]},"ticketExternalID":{"description":"External ID from Zendesk ticket","type":"string"},"userFriendlyError":{"type":"string","description":"Descriptive information about the potential error","deprecated":true},"userId":{"type":"integer","description":"ID of the user who created the request"},"version":{"type":"integer","description":"Version of the request. Always = 1"},"provisioning":{"default":"dedicated-vm","enum":["dedicated-vm"],"type":"string"}}},"ClusterResizeRequest":{"type":"object","x-public":true,"properties":{"dcNodes":{"type":"array","description":"Mapping for the requested changes for each DC","items":{"$ref":"#/components/schemas/ClusterResizeDCNodes"}}}},"ClusterResizeResponse":{"x-public":true,"properties":{"accountID":{"description":"ID of the account which was used to create the request","type":"integer"},"clusterID":{"description":"ID of the cluster","type":"integer"},"id":{"description":"ID of the request","type":"integer"},"progressDescription":{"description":"Request progress description","type":"string"},"progressPercent":{"description":"Request processing progress","type":"integer"},"provisioning":{"default":"dedicated-vm","enum":["dedicated-vm"],"type":"string"},"requestBody":{"description":"JSON body of the request","type":"string"},"requestType":{"description":"Defines the type of the request","enum":["RESIZE_CLUSTER_V2","RESIZE_CLUSTER_V3"],"type":"string"},"status":{"description":"Status of the request","enum":["QUEUED","IN_PROGRESS","FAILED","COMPLETED","CANCELLED"],"type":"string"},"userFriendlyError":{"type":"string","description":"Descriptive information about the potential error","deprecated":true},"userID":{"description":"ID of the user who created the request","type":"integer"},"version":{"description":"Version of the request. Always = 1","type":"integer"}},"type":"object"},"ClusterMaintenanceWindow":{"x-public":true,"properties":{"duration":{"type":"integer","description":"only 3-hour time windows are allowed (10800000 seconds)","example":10800000},"rrule":{"type":"string","example":"FREQ=DAILY;BYDAY=WE;BYHOUR=14;BYMINUTE=0;BYSECOND=0"}}},"ScalingMode":{"type":"string","description":"Scaling mode of the cluster","x-public":true,"enum":["standard","xcloud"],"x-enum-varnames":["ScalingStandard","ScalingXCloud"]},"ClusterConnectionAwaitingData":{"type":"object","x-public":true,"additionalProperties":{"type":"string"}},"APIDCScaling":{"type":"object","x-public":true,"properties":{"instanceFamilies":{"type":"array","items":{"type":"string"}},"instanceTypeIDs":{"type":"array","items":{"type":"integer"}},"policies":{"$ref":"#/components/schemas/APIDCScalingPolicies"}}},"APIDCScalingPolicies":{"type":"object","x-public":true,"properties":{"storage":{"$ref":"#/components/schemas/APIDCScalingPolicyStorage"},"vcpu":{"$ref":"#/components/schemas/APIDCScalingPolicyVCPU"}}},"APIDCScalingPolicyStorage":{"type":"object","x-public":true,"properties":{"min":{"type":"integer","description":"Minimum storage size for your cluster, in GB. This total provisioned\nstorage will not be fully available for data, because the data takes\nmore storage than its size due to replication."},"targetUtilization":{"type":"number","description":"Target utilization ratio. Percentage, 0 to 1","format":"float64"}}},"APIDCScalingPolicyVCPU":{"type":"object","x-public":true,"properties":{"min":{"type":"integer","description":"Minimum number of vCPUs"}}},"ClusterResizeDCNodes":{"type":"object","x-public":true,"properties":{"dcId":{"type":"integer","description":"DCID is the cluster DC ID for which the changes are requested"},"instanceTypeId":{"type":"integer","description":"InstanceTypeID refers to what instance type should now be used for the DC.\nPlease see implementation details to know if this change is done automatically for by support."},"wantedSize":{"type":"integer","description":"WantedSize is the new size for scaling, can be greater or smaller than the current size\nNeeds to account for RF (cluster replication factor)\nValidation will reject it unless size%RF == 0"}},"required":["dcId","wantedSize"]},"MetricName":{"type":"string","x-public":true,"description":"Available metric names for cluster monitoring","enum":["NODES_UP","NODES_DOWN","STORAGE_FREE","STORAGE_USED","STORAGE_FREE_SANDBOX","STORAGE_USED_SANDBOX","STORAGE_UTILIZATION_AVG_30D","STORAGE_UTILIZATION_AVG_30D_SANDBOX","CPU_LOAD","TOTAL_REQUESTS_RATE","READS_RATE","WRITES_RATE","LATENCY_READ_AVERAGE","LATENCY_READ_95TH","LATENCY_WRITE_AVERAGE","LATENCY_WRITE_95TH","ALTERNATOR_LATENCY_GETITEM_AVERAGE","ALTERNATOR_LATENCY_PUTITEM_AVERAGE","ALTERNATOR_LATENCY_GETITEM_95TH","ALTERNATOR_LATENCY_PUTITEM_95TH","ALTERNATOR_GETITEM_NUM_OPS","ALTERNATOR_PUTITEM_NUM_OPS","ALTERNATOR_QUERY_NUM_OPS","ALTERNATOR_SCAN_NUM_OPS"]},"CloudAccount":{"x-public":true,"properties":{"checkStatus":{"description":"Holds the status of an AccountCloudCredential validation","$ref":"#/components/schemas/CloudAccountCheckStatus"},"cloudProviderId":{"description":"ID of the cloud provider (full list [get] /deployment/cloud-providers)","type":"integer"},"id":{"description":"Internal ID of the cloud account","type":"integer"},"owner":{"description":"Owner of the account [Scylla, Account]. Owner = Account means it's BYOA deployment.","enum":["Scylla","Account"],"type":"string"},"properties":{"$ref":"#/components/schemas/AWSCloudAccountProperties","description":"AWS cloud account properties"},"state":{"type":"string","description":"Status of the cloud account","enum":["NEW","ACTIVE","DELETED"]}},"type":"object"},"CloudAccountCheckStatus":{"x-public":true,"properties":{"boundaryPolicy":{"description":"BoundaryPolicy is the status of the boundary policy in relation to the golden","type":"string"},"cloudPolicy":{"description":"CloudPolicy is the status of the cloud policy in relation to the golden","type":"string"},"error":{"description":"Error contains the last fatal error, if any","type":"string"},"transientError":{"description":"TransientError contains the last transient error, if any","type":"string"}},"type":"object"},"AWSCloudAccountProperties":{"x-public":true,"properties":{"awsAccountId":{"type":"string","description":"AWS Account ID"},"boundaryPolicyArn":{"type":"string","description":"ARN of the boundary policy"},"cloudPolicyArn":{"type":"string","description":"ARN of the policy"},"cloudRoleArn":{"type":"string","description":"ARN of the role"},"cloudRoleExternalId":{"type":"string","description":"UUID generated by scylla-cloud (for internal reason)"}},"type":"object"},"scyllaVersion":{"type":"object","description":"Represent version of the ScyllaDB installed on nodes","x-public":true,"properties":{"id":{"type":"integer","description":"ID of the service version","example":103},"version":{"type":"string","description":"Name of the service version","example":"2021.1.16"},"description":{"type":"string","description":"Version description","example":"Scylla Enterprise 2021.1.16"},"newCluster":{"type":"string","description":"Describes if this version should be available for creating new clusters using the frontend wizard","example":"DISABLED","enum":["ENABLED","DISABLED"]},"serviceId":{"type":"integer","description":"ID of the service","example":1},"name":{"type":"string","description":"Version name","example":"Scylla Enterprise"}}},"cloudProvider":{"type":"object","description":"Cloud provider description","x-public":true,"properties":{"id":{"type":"integer","description":"ID of the cloud provider (internal for scylla-cloud)","example":1},"name":{"type":"string","description":"Name of the cloud provider","example":"AWS"},"rootAccountId":{"type":"string","description":"Cloud provider account ID","example":"123456789012"}}},"region":{"type":"object","description":"Region and continent description","x-public":true,"properties":{"id":{"type":"integer","description":"ID of the region (internal for scylla-cloud)","example":30},"externalId":{"type":"string","description":"External ID of the cloud provider region","example":"us-east1"},"cloudProviderId":{"type":"integer","description":"ID of the cloud provider (full list [get] /deployment/cloud-providers)","example":2},"name":{"type":"string","description":"Name of the region","example":"us-east1"},"dcName":{"type":"string","description":"Name of the data center","example":"GCE_US_EAST_1"},"fullName":{"type":"string","description":"Full name of the region","example":"us-east1 (South Carolina)"},"continent":{"type":"string","description":"Continent name"},"backupStorageGBCost":{"type":"number","description":"Cost of storing 1 Gigabyte in backup","example":0.02},"trafficSameRegionInGBCost":{"type":"number","description":"Cost of receiving 1 Gigabyte from the same region","example":0},"trafficSameRegionOutGBCost":{"type":"number","description":"Cost of sending 1 Gigabyte to the same region","example":0},"trafficCrossRegionOutGBCost":{"type":"number","description":"Cost of sending 1 Gigabyte to another region","example":0},"trafficInternetOutGBCost":{"type":"number","description":"Cost of sending 1 Gigabyte to the internet","example":0},"multiRegionExternalId":{"description":"External ID of the cloud provider multi-region","example":"us","type":"string"}}},"instance":{"type":"object","description":"Cloud provider instance pricing description","x-public":true,"properties":{"id":{"type":"integer","description":"ID of the instance type (internal for scylla-cloud)","example":40},"externalId":{"type":"string","description":"External ID of the cloud provider instance type","example":"n2-highmem-2"},"cloudProviderId":{"type":"integer","description":"ID of the cloud provider (full list [get] /deployment/cloud-providers)","example":2},"groupDefault":{"type":"boolean","description":"GroupDefault says which one is the default in a group of matching external_id"},"displayOrder":{"type":"integer","description":"Position when showing multiple instance types","example":3},"memory":{"type":"integer","description":"Instance type RAM size in Megabytes","example":16384},"localDiskCount":{"type":"integer","description":"Instance type disk count","example":1},"totalStorage":{"type":"integer","description":"Instance type total storage size (uses base of 10 GB)","example":375},"cpuCount":{"type":"integer","description":"Instance type CPU core count","example":2},"networkSpeed":{"type":"integer","description":"Instance type network bandwidth in Megabytes per second","example":10},"networkSpeedDescription":{"description":"Network performance description","example":"Maximum egress bandwidth, 10 Gbps","type":"string"},"baseNetworkSpeed":{"description":"The network performance in Megabytes per second","example":5,"type":"integer"},"externalStorageNetworkSpeed":{"type":"integer","description":"Cloud provider storage bandwidth in Megabytes per second","example":0},"costPerHour":{"type":"number","description":"Deprecated in favor of InstanceCostHourly","deprecated":true},"environment":{"type":"string","description":"Development clusters lack advanced features (e.g. Scylla Manager, monitoring alerts and many others) which are present in Production clusters","enum":["PRODUCTION","DEVELOPMENT"]},"licenseCostOnDemandPerHour":{"type":"number","description":"Deprecated in favor of SubscriptionCostHourly","deprecated":true},"subscriptionCostHourly":{"type":"number","description":"Scylla related part of the cost per hour","example":0.0956},"subscriptionCostHourlyXCloud":{"type":"number","description":"Scylla related part of the cost per hour for XCloud","example":0.12},"subscriptionCostHourlyXCloudBYOA":{"type":"number","description":"Scylla related part of the cost per hour for XCloud BYOA","example":0.15},"subscriptionCostMonthly":{"type":"number","description":"Scylla related part of the cost per month","example":54},"subscriptionCostMonthlyXCloud":{"type":"number","description":"Scylla related part of the cost per month for XCloud","example":65},"subscriptionCostYearly":{"type":"number","description":"Scylla related part of the cost per year","example":560},"subscriptionCostYearlyXCloud":{"type":"number","description":"Scylla related part of the cost per year for XCloud","example":650},"instanceCostHourly":{"type":"number","description":"Cloud provider related part of the cost","example":0.03},"instanceFamily":{"description":"Describes instance type best price-performance workloads","example":"n2","type":"string"},"freeTier":{"description":"This instance type can be used on a free tier cluster","type":"boolean"}}},"Status":{"type":"string","x-public":true,"enum":["pending","provisioning","provisioned","locking","locked","unlocking","unlocked","deleting","deleted","error","action_needed"]},"Key":{"type":"object","x-public":true,"properties":{"id":{"type":"string","example":"key-QH4r96V48qFtWbXL"},"createdAt":{"type":"string","format":"date-time","example":"2019-10-12T07:20:50.52Z"},"updatedAt":{"type":"string","format":"date-time","example":"2019-10-12T07:20:50.52Z"},"provider":{"type":"string","example":"aws"},"alias":{"type":"string","example":"MyKey"},"tenantId":{"type":"string","example":"123","description":"Account ID"},"stackId":{"type":"string","example":"stk-qH4r96V48qFtWbXL"},"roleId":{"type":"string","example":"role-6u8mUN5Dv3ivt5I5"},"replicas":{"type":"array","items":{"type":"string"},"example":["keyr-QH4r96V48qFtWbXL","keyr-qH4r69V49qFtWbXL"],"description":"replicas property has at least 1 element when Key.status reaches 'provisioned'"},"status":{"$ref":"#/components/schemas/Status"},"attrs":{"type":"object","additionalProperties":true,"properties":{"clusterId":{"type":"string","example":"1024"},"writeLockId":{"type":"string","example":"keylck-qsbTIsk0F0jEBOrN"},"masterRegion":{"type":"string","example":"us-east-1"},"masterArn":{"type":"string","example":"arn:aws:kms:us-east-1:043400831220:key/mrk-6e99695fea2e4ea19068db94c4cd3b2d"},"regions":{"type":"array","items":{"type":"string"},"example":["us-east-1"]},"stack":{"type":"object","properties":{"name":{"type":"string","example":"scylladb-lab-stk-T2kTQyYAsxqqA8ni"},"roleId":{"type":"string","example":"role-FHT7zqSYnDfuTcn7"}}},"nextAction":{"type":"object","properties":{"type":{"type":"string","enum":["create_stack","delete_stack","resolve_stack_drift"]},"template":{"type":"string","example":"terraform"},"url":{"type":"string","example":"https://byok-lab-stkbckt.s3.us-east-1.amazonaws.com/templates/key.tf.json"},"stack":{"type":"object","additionalProperties":true,"properties":{"templateUrl":{"type":"string","example":"https://byok-lab-stkbckt.s3.us-east-1.amazonaws.com/templates/key.tf.json"},"parameters":{"type":"object","additionalProperties":true,"example":{"project":"sc-dbaas-byoa-lab-434006","region":"global","stackSecret":"nMkBobR6PQJUAlCVd3yoyQqx92CZfkanq8uj"}},"userParameters":{"type":"array","items":{"type":"string"}}}}}},"crossAccountDataKeyAccessRole":{"type":"object","additionalProperties":true}},"description":"Key.attrs.nextAction.url attribute is available when Key.status is 'action_needed' and provider is 'aws'\n"}}},"FirewallRule":{"x-public":true,"properties":{"clusterId":{"type":"integer","description":"ID of the cluster"},"id":{"type":"integer","description":"ID of the firewall allowed rule"},"address":{"type":"string","description":"CIDR notation","example":"192.0.2.0/24"}},"type":"object"},"CidrBlock":{"type":"string","description":"CIDR notation","example":"172.31.1.1/16","x-public":true},"Account":{"x-public":true,"properties":{"accountId":{"description":"ID of the account","type":"integer"},"accountStatus":{"description":"Status of the account","enum":["ACTIVE","INACTIVE","DELETED"],"type":"string"},"role":{"description":"Defines user role within the account","enum":["ADMIN","MAINTAINER","VIEWER"],"type":"string"},"userAccountStatus":{"description":"User account status","enum":["ACTIVE","INACTIVE","DELETED"],"type":"string"},"name":{"description":"Account name","type":"string"},"userId":{"description":"ID of the user","type":"integer"}},"type":"object"},"NotificationEmail":{"x-public":true,"type":"object","properties":{"email":{"description":"Deprecated: Emails should be used instead.","type":"string","deprecated":true},"emails":{"type":"array","items":{"type":"string"}},"clusterNotifications":{"type":"array","items":{"$ref":"#/components/schemas/ClusterNotification"}}}},"ClusterNotification":{"x-public":true,"type":"object","properties":{"clusterId":{"description":"ID of the cluster","type":"integer"},"clusterName":{"description":"Name of the cluster","type":"string"},"emails":{"type":"array","items":{"type":"string"}}}},"errorObject":{"type":"object","x-public":true,"properties":{"error":{"type":"string","example":"040101"}}},"VectorSearchStatus":{"x-public":true,"enum":["HEALTHY","DEGRADED","UNHEALTHY","UNKNOWN"],"type":"string","x-enum-varnames":["vectorSearchStatusHealthy","vectorSearchStatusDegraded","vectorSearchStatusUnhealthy","vectorSearchStatusUnknown"]},"VectorSearchNodeStatus":{"type":"string","description":"Status of the node","x-public":true,"enum":["ACTIVE","INACTIVE","PENDING_DELETE","DELETED","QUEUED"]},"MemoryInfo":{"type":"object","x-public":true,"properties":{"freeGiB":{"format":"float64","type":"number"},"usagePercent":{"format":"float64","type":"number"}}},"CPUInfo":{"type":"object","x-public":true,"properties":{"usagePercent":{"format":"float64","type":"number"}}},"VectorSearchNode":{"type":"object","description":"Details about the vector search nodes in the rack","x-public":true,"properties":{"id":{"type":"integer","description":"ID of the vector search node","example":125},"instanceTypeId":{"type":"integer","description":"ID of the instance type used for the vector search node","example":175},"status":{"$ref":"#/components/schemas/VectorSearchNodeStatus"},"up":{"description":"Shows whether the node is up and running.","type":"boolean"},"cpu":{"$ref":"#/components/schemas/CPUInfo"},"memory":{"$ref":"#/components/schemas/MemoryInfo"},"indexCount":{"description":"Number of vector search indexes stored on the node.","type":"integer"}}},"AvailabilityZone":{"type":"object","description":"Details about the availability zone where vector search nodes are deployed","x-public":true,"properties":{"azid":{"type":"string","description":"ID of the availability zone","example":"use1-az5"},"rackName":{"type":"string","description":"Name of the rack","example":"use1-az5"},"nodes":{"type":"array","description":"List of vector search nodes in the availability zone","items":{"$ref":"#/components/schemas/VectorSearchNode"}}}},"VectorSearchRequest":{"type":"object","description":"Parameters for adding vector search nodes to an existing cluster","x-public":true,"required":["nodeCount","defaultInstanceTypeId"],"properties":{"nodeCount":{"type":"integer","example":2,"minimum":1,"maximum":27,"description":"Number of vector search nodes to create in the datacenter, nodes are distributed evenly across cluster racks"},"defaultInstanceTypeId":{"type":"integer","description":"ID of the instance type to use for vector search nodes (instance type list [get] /deployment/cloud-provider/{}/region/{}?target=VECTOR_SEARCH)"}}},"VectorSearchInfo":{"type":"object","description":"Information about a vector search node in a cluster datacenter","x-public":true,"properties":{"availabilityZones":{"type":"array","description":"List of availability zones where vector search nodes are deployed","items":{"$ref":"#/components/schemas/AvailabilityZone"}},"status":{"$ref":"#/components/schemas/VectorSearchStatus"}}}},"parameters":{"trace":{"in":"header","name":"traceparent","schema":{"type":"string"}},"nodeId":{"in":"path","description":"Node ID","name":"nodeId","required":true,"schema":{"type":"integer"}},"accountId":{"in":"path","description":"Account ID","name":"accountId","required":true,"schema":{"type":"integer"}},"cloudProviderId":{"in":"path","description":"Cloud Provider ID (full list [get] /deployment/provider)","name":"cloudProviderId","required":true,"schema":{"type":"integer","example":1}},"regionId":{"in":"path","description":"Cloud Region ID (full list [get] /deployment/provider/{}/region)","name":"regionId","required":true,"schema":{"type":"integer","example":30}},"clusterId":{"in":"path","description":"Cluster ID","name":"clusterId","required":true,"schema":{"type":"integer"}},"peerId":{"in":"path","description":"Peer ID","name":"peerId","required":true,"schema":{"type":"integer"}},"keyId":{"in":"path","description":"Key ID","name":"keyId","required":true,"schema":{"type":"string"}},"connectionId":{"in":"path","description":"Connection ID","name":"connectionId","required":true,"schema":{"type":"integer"}},"dcId":{"in":"path","description":"Datacenter ID","name":"dcId","required":true,"schema":{"type":"integer"}},"defaults":{"in":"query","description":"Should include default values","name":"defaults","required":false,"schema":{"type":"boolean","default":false}},"requestType":{"description":"type of request","in":"query","name":"type","schema":{"type":"string","enum":["ADD_DC","CREATE_CLUSTER","DELETE_CLUSTER","RESIZE_CLUSTER_V2","RESIZE_CLUSTER_V3","UPGRADE_CLUSTER","SCALE_CLUSTER","INSTALL_MANAGER","DNS","CREATE_VPC_PEERING","DELETE_VPC_PEERING","CREATE_CLUSTER_CONNECTION","DELETE_CLUSTER_CONNECTION","UPDATE_CLUSTER_CONNECTION","INSTALL_VECTOR_SEARCH","RESIZE_VECTOR_SEARCH","DELETE_VECTOR_SEARCH"]}},"requestStatus":{"description":"status of request","in":"query","name":"status","schema":{"type":"string","enum":["QUEUED","IN_PROGRESS","FAILED","COMPLETED"]}},"target":{"description":"target for the requested instance types","in":"query","name":"target","schema":{"type":"string","enum":["VECTOR_SEARCH"]}}}},"tags":[]}