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
"{\n \"APACHE_CASSANDRA\": [\n \"apache-cassandra-4.0.1.1\",\n \"apache-cassandra-3.11.11.1\",\n \"apache-cassandra-3.11.8.4\"\n ],\n \"REDIS\": [\n \"redis:7.0.5\"\n ],\n \"KAFKA\": [\n \"apache-kafka:3.1.2\",\n \"apache-kafka:3.0.2\",\n \"apache-kafka:2.8.2\",\n ],\n \"CADENCE\": [\n \"cadence:0.22.4\"\n ],\n \"OPENSEARCH\": [\n \"opensearch:1.3.7\",\n \"opensearch:2.2.1\"\n ],\n \"SPARK\": [\n \"apache-spark:2.1.3\",\n \"apache-spark:2.1.3\",\n \"apache-spark:2.3.2\"\n ],\n \"KAFKA_CONNECT\": [\n \"kafka-connect:2.7.1\",\n \"kafka-connect:2.8.2\",\n \"kafka-connect:3.0.2\",\n \"kafka-connect:3.1.2\"\n ],\n \"KAFKA_SCHEMA_REGISTRY\": [\n \"kafka-schema-registry:5.0.0\",\n \"kafka-schema-registry:5.0.4\"\n ],\n \"KARAPACE_SCHEMA_REGISTRY\": [\n \"karapace-schema-registry:3.4.3\"\n ],\n \"KAFKA_REST_PROXY\": [\n \"kafka-rest-proxy:5.0.0\"\n ], \n \"KARAPACE_REST_PROXY\": [\n \"karapace-rest-proxy:3.4.3\"\n ],\n \"APACHE_ZOOKEEPER\": [\n \"apache-zookeeper:3.6.3\",\n \"apache-zookeeper:3.7.1\"\n ],\n \"POSTGRESQL\": [\n \"postgresql:15.1\",\n \"postgresql:14.6\",\n \"postgresql:14.5\",\n \"postgresql:13.9\"\n \"postgresql:13.8\"\n ],\n \"PGBOUNCER\": [\n \"pgbouncer:1.17.0\"\n ]\n}\n"

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-3.11.6
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
[
  • {
    }
]

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,SPARK
bundleVersions
string

A valid combination of bundle versions separated by commas, must be of the bundle types given

Example: bundleVersions=apache-cassandra-4.0.1,apache-spark:2.1.3
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
{
  • "AWS_VPC": {
    },
  • "AZURE": {},
  • "GCP": {}
}

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
[
  • {
    }
]