Bundle Information

Operations related to retrieving information on bundles.

Retrieve all compatible bundles

Retrieve all compatible bundles for the account.

SecurityBasic Authentication

Responses

200

Successfully retrieved all compatible bundles.

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

get/provisioning/v1/bundles/bundle_type

Request samples

Response samples

application/json

{"APACHE_CASSANDRA": ["apache-cassandra-4.1.3",
"apache-cassandra-4.0.11",
"apache-cassandra-3.11.16.1"
],
"APACHE_ZOOKEEPER": ["apache-zookeeper:3.8.4"
],
"CADENCE": ["cadence:1.2.2"
],
"KAFKA": ["apache-kafka:3.7.1",
"apache-kafka:3.6.2",
"apache-kafka:3.6.1"
],
"KAFKA_CONNECT": ["kafka-connect:3.7.1",
"kafka-connect:3.6.2",
"kafka-connect:3.6.1"
],
"KARAPACE_REST_PROXY": ["karapace-rest-proxy:3.15.0"
],
"KARAPACE_SCHEMA_REGISTRY": ["karapace-schema-registry:3.15.0"
],
"OPENSEARCH": ["opensearch:1.3.17",
"opensearch:2.16.0"
],
"PGBOUNCER": ["pgbouncer:1.23.1"
],
"POSTGRESQL": ["postgresql:16.4",
"postgresql:15.8",
"postgresql:14.13"
],
"REDIS": ["redis:7.2.4"
],
"VALKEY": ["valkey:7.2.5"
]
}

Retrieve bundle version compatibility info

Retrieve bundle options and compatibility list for a specific bundle version.

SecurityBasic Authentication

Request

path Parameters

BundleVersion

required

string

A specific version of a bundle.

Example: apache-cassandra-4.1.3

Responses

200

Successfully retrieved all bundle options and compatibility list for a specific bundle version.

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

get/provisioning/v1/bundles/detail/{BundleVersion}

Request samples

Response samples

application/json

[{"bundle": "APACHE_CASSANDRA",
"bundle_options": {"authnAuthz": {"default": "false",
"description": "",
"required": "false",
"type": "boolean"
},
"backupEnabled": {"default": "true",
"description": "",
"required": "false",
"type": "boolean"
},
"clientEncryption": {"default": "false",
"description": "",
"required": "false",
"type": "boolean"
},
"luceneEnabled": {"default": "false",
"description": "",
"required": "false",
"type": "boolean"
},
"usePrivateBroadcastRPCAddress": {"default": "false",
"description": "",
"required": "false",
"type": "boolean"
}
},
"compatible_with": [{"SPARK": "apache-spark:2.3.2"
},
{"SPARK": "apache-spark:2.1.3"
}
],
"requires_bundle": null,
"version": "apache-cassandra-3.11.6"
}
]

Retrieve compatible node sizes

Retrieve a list of compatible node sizes for a specific bundle combination.

SecurityBasic Authentication

Request

query Parameters

bundles required	string A valid combination of bundles separated by commas. Example: bundles=APACHE_CASSANDRA,DEBEZIUM_CASSANDRA_CONNECTOR
bundleVersions	string A valid combination of bundle versions separated by commas, must be of the bundle types given Example: bundleVersions=apache-cassandra-4.0.11,debezium-connector-cassandra:2.0.1

Responses

200

Successfully retrieved all compatible node sizes for a specific bundle combination.

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

get/provisioning/v1/bundles/node_size

Request samples

Response samples

application/json

"{\n  \"AWS_VPC\": {\n    \"nodeSizes\": [\n      \"i3en.xlarge\",\n      \"CAS-DEV-t4g.small-5\",\n      \"CAS-DEV-t4g.small-30\",\n      \"CAS-DEV-t4g.medium-30\",\n      \"CAS-DEV-t4g.medium-80\",\n      \"CAS-PRD-m6g.large-120\",\n      \"CAS-PRD-m6g.large-250\",\n      \"CAS-PRD-m6g.large-400\",\n      \"CAS-PRD-m6g.large-600\",\n      \"CAS-PRD-r6g.large-250\",\n      \"CAS-PRD-r6g.large-400\",\n      \"CAS-PRD-r6g.large-600\",\n      \"CAS-PRD-r6g.large-800\",\n      \"CAS-PRD-r6g.large-1200\",\n      \"CAS-PRD-r6g.large-1600\",\n      \"CAS-PRD-r6g.xlarge-400\",\n      \"CAS-PRD-r6g.xlarge-600\",\n      \"CAS-PRD-r6g.xlarge-800\",\n      \"CAS-PRD-r6g.xlarge-1200\",\n      \"CAS-PRD-r6g.xlarge-1600\",\n      \"CAS-PRD-r6g.xlarge-2400\",\n      \"CAS-PRD-r6g.xlarge-3200\",\n      \"CAS-PRD-r6g.2xlarge-800\",\n      \"CAS-PRD-r6g.2xlarge-1200\",\n      \"CAS-PRD-r6g.2xlarge-1600\",\n      \"CAS-PRD-r6g.2xlarge-2400\",\n      \"CAS-PRD-r6g.2xlarge-3200\",\n      \"CAS-PRD-r6g.4xlarge-800\",\n      \"CAS-PRD-r6g.4xlarge-1200\",\n      \"CAS-PRD-r6g.4xlarge-1600\",\n      \"CAS-PRD-r6g.4xlarge-2400\",\n      \"CAS-PRD-r6g.4xlarge-3200\",\n      \"CAS-PRD-m7g.large-120\",\n      \"CAS-PRD-m7g.large-250\",\n      \"CAS-PRD-m7g.large-400\",\n      \"CAS-PRD-m7g.large-600\",\n      \"CAS-PRD-r7g.large-250\",\n      \"CAS-PRD-r7g.large-400\",\n      \"CAS-PRD-r7g.large-600\",\n      \"CAS-PRD-r7g.large-800\",\n      \"CAS-PRD-r7g.large-1200\",\n      \"CAS-PRD-r7g.large-1600\",\n      \"CAS-PRD-r7g.xlarge-400\",\n      \"CAS-PRD-r7g.xlarge-600\",\n      \"CAS-PRD-r7g.xlarge-800\",\n      \"CAS-PRD-r7g.xlarge-1200\",\n      \"CAS-PRD-r7g.xlarge-1600\",\n      \"CAS-PRD-r7g.xlarge-2400\",\n      \"CAS-PRD-r7g.xlarge-3200\",\n      \"CAS-PRD-r7g.2xlarge-800\",\n      \"CAS-PRD-r7g.2xlarge-1200\",\n      \"CAS-PRD-r7g.2xlarge-1600\",\n      \"CAS-PRD-r7g.2xlarge-2400\",\n      \"CAS-PRD-r7g.2xlarge-3200\",\n      \"CAS-PRD-r7g.4xlarge-800\",\n      \"CAS-PRD-r7g.4xlarge-1200\",\n      \"CAS-PRD-r7g.4xlarge-1600\",\n      \"CAS-PRD-r7g.4xlarge-2400\",\n      \"CAS-PRD-r7g.4xlarge-3200\",\n      \"m5xl-800-v2\",\n      \"t3.small-v2\",\n      \"m5xl-1600-v2\",\n      \"r5xl-2000-v2\",\n      \"c5d.2xlarge-v2\",\n      \"m5xl-400-v2\",\n      \"i3.2xlarge-v2\",\n      \"m5l-250-v2\",\n      \"t3.medium-v2\",\n      \"r5xl-1200-v2\",\n      \"CAS-PRD-i3.4xlarge-3538\",\n      \"CAS-PRD-i3en.2xlarge-4656\"\n    ],\n    \"document\": \"https://aws.amazon.com/ec2/instance-types/\"\n  },\n  \"AZURE_AZ\": {\n    \"nodeSizes\": [\n      \"Standard_DS13_v2-2046-an\",\n      \"Standard_DS2_v2-256-an\",\n      \"Standard_DS12_v2-1023-an\",\n      \"Standard_DS12_v2-512-an\",\n      \"Standard_DS12_v2-2046-an,\"\n      \"CAS-PRD-Standard_L8s_v3-1788\"\n    ],\n    \"document\": \"https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-vm-sizes\"\n  },\n  \"GCP\": {\n    \"nodeSizes\": [\n      \"CAS-DEV-n1-standard-1-5\",\n      \"CAS-DEV-n1-standard-2-30\",\n      \"CAS-DEV-n1-standard-2-80\",\n      \"CAS-PRD-n2-standard-2-120\",\n      \"CAS-PRD-n2-standard-2-250\",\n      \"CAS-PRD-n2-standard-2-400\",\n      \"CAS-PRD-n2-standard-2-600\",\n      \"CAS-PRD-n2-highmem-2-250\",\n      \"CAS-PRD-n2-highmem-2-400\",\n      \"CAS-PRD-n2-highmem-2-600\",\n      \"CAS-PRD-n2-highmem-2-800\",\n      \"CAS-PRD-n2-highmem-2-1200\",\n      \"CAS-PRD-n2-highmem-2-1600\",\n      \"CAS-PRD-n2-highmem-2-250\",\n      \"CAS-PRD-n2-highmem-4-400\",\n      \"CAS-PRD-n2-highmem-4-600\",\n      \"CAS-PRD-n2-highmem-4-800\",\n      \"CAS-PRD-n2-highmem-4-1200\",\n      \"CAS-PRD-n2-highmem-4-1600\",\n      \"CAS-PRD-n2-highmem-4-2400\",\n      \"CAS-PRD-n2-highmem-4-3200\",\n      \"CAS-PRD-n2-highmem-8-1200\",\n      \"CAS-PRD-n2-highmem-8-1600\",\n      \"CAS-PRD-n2-highmem-8-2400\",\n      \"CAS-PRD-n2-highmem-8-3200\",\n      \"CAS-PRD-n2-highmem-16-1200\",\n      \"CAS-PRD-n2-highmem-16-1600\",\n      \"CAS-PRD-n2-highmem-16-2400\",\n      \"CAS-PRD-n2-highmem-16-3200\",\n      \"CAS-PRD-n2-highmem-16-2400\",\n      \"CAS-PRD-n2-highmem-16-3200\"\n    ],\n    \"document\": \"https://cloud.google.com/compute/docs/machine-types\"\n  }\n}\n"

Retrieve provisioning options

Call this endpoint to retrieve all available provisioning options.

SecurityBasic Authentication

Request

query Parameters

providerAccountName	string Default: "INSTACLUSTR" For customers running in their own account. Your provider account can be found on the Create Cluster page on the console, or the “Provider Account” property on any existing cluster. For customers running in Instaclustr account, this property may be omitted. Example: providerAccountName=INSTACLUSTR
provider	string Filter by provider. If not provided, all available providers are returned. Enum: "AWS_VPC" "AZURE" "GCP" Example: provider=AWS_VPC
region	string Filter by region. If not provided, all available regions are returned. Example: region=US_EAST_2

Responses

200

Successfully retrieved provisioning options

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

get/provisioning/v1/describe-options

Request samples

Response samples

application/json

[{"name": "AWS_VPC",
"displayName": "Amazon Web Services",
"regions": [{"name": "US_WEST_2",
"displayName": "US West (Oregon)",
"mainApplicationVersion": [{"bundleType": "APACHE_CASSANDRA",
"bundleVersion": "apache-cassandra-4.1.3",
"displayVersion": "Apache Cassandra 4.1.3"
}
],
"racks": ["us-west-2a",
"us-west-2a-ic",
"us-west-2b",
"us-west-2c",
"us-west-2d"
],
"nodeSizes": [{"name": "t3.small",
"cost": 4900,
"diskQuota": 5,
"memoryQuota": 4000,
"cpuCores": 2,
"ssdBacked": true,
"freeTrialEligible": true
}
]
}
]
}
]

➔ Next to Bundle User