Cluster Resource

Operations related to provisioning clusters.

Create new cluster

Provision a new instaclustr cluster.

Note: a KAFKA_CONNECT cluster needs a running KAFKA cluster to connect to.

SecurityBasic Authentication
Request
Request Body schema: application/json
clusterName
required
string [ 3 .. 32 ] characters [a-zA-Z0-9][a-zA-Z0-9_-]*

Cluster name

required
Array of objects (BundleRequest)
required
object (Provider)
privateNetworkCluster
boolean
Default: false

Creates the cluster with private network only, see Private Network Clusters

Note: Private Network add-on is only supported on AWS_VPC/GCP/ONPREMISES for Kafka Connect. The target Kafka cluster has to be on AWS_VPC/GCP/ONPREMISES respectively as well.

pciCompliantCluster
boolean
Default: false

Creates a PCI compliant cluster, see PCI Compliance. Can only be applied clusters provisioned on AWS_VPC, running Cassandra, Kafka, Elasticsearch and Redis. PCI compliance cannot be enabled if the cluster has Spark.

object (PrivateLink)

Creates a PrivateLink cluster, see PrivateLink

PrivateLink can only be supported on AWS_VPC for Kafka.

slaTier
string
Default: "PRODUCTION"

Non-production clusters may receive lower priority support and reduced SLAs. Production tier is not available when using Developer class nodes. You can find more information here.

Enum: "PRODUCTION" "NON_PRODUCTION"
nodeSize
required
string

Available cluster node sizes

Apache Cassandra [APACHE_CASSANDRA]

Amazon Web Services [AWS_VPC]
Node Size
c5d.2xlarge-v2
CAS-DEV-t4g.medium-30
CAS-DEV-t4g.medium-80
CAS-DEV-t4g.small-30
CAS-DEV-t4g.small-5
CAS-PRD-i3.4xlarge-3538
CAS-PRD-i3en.2xlarge-4656
CAS-PRD-m6g.large-120
CAS-PRD-m6g.large-250
CAS-PRD-m6g.large-400
CAS-PRD-m6g.large-600
CAS-PRD-r6g.2xlarge-1200
CAS-PRD-r6g.2xlarge-1600
CAS-PRD-r6g.2xlarge-2400
CAS-PRD-r6g.2xlarge-3200
CAS-PRD-r6g.2xlarge-800
CAS-PRD-r6g.4xlarge-1200
CAS-PRD-r6g.4xlarge-1600
CAS-PRD-r6g.4xlarge-2400
CAS-PRD-r6g.4xlarge-3200
CAS-PRD-r6g.4xlarge-800
CAS-PRD-r6g.large-1200
CAS-PRD-r6g.large-1600
CAS-PRD-r6g.large-250
CAS-PRD-r6g.large-400
CAS-PRD-r6g.large-600
CAS-PRD-r6g.large-800
CAS-PRD-r6g.xlarge-1200
CAS-PRD-r6g.xlarge-1600
CAS-PRD-r6g.xlarge-2400
CAS-PRD-r6g.xlarge-3200
CAS-PRD-r6g.xlarge-400
CAS-PRD-r6g.xlarge-600
CAS-PRD-r6g.xlarge-800
i3.2xlarge-v2
i3en.xlarge
c5d.2xlarge (deprecated)
i3.2xlarge (deprecated)
m5l-250 (deprecated)
m5l-250-v2 (deprecated)
m5xl-1600 (deprecated)
m5xl-1600-v2 (deprecated)
m5xl-400 (deprecated)
m5xl-400-v2 (deprecated)
m5xl-800 (deprecated)
m5xl-800-v2 (deprecated)
r5xl-1200 (deprecated)
r5xl-1200-v2 (deprecated)
r5xl-2000 (deprecated)
r5xl-2000-v2 (deprecated)
resizeable-large(r5-2xl) (deprecated)
resizeable-large(r5-2xl)-v2 (deprecated)
resizeable-large(r5-4xl) (deprecated)
resizeable-large(r5-4xl)-v2 (deprecated)
resizeable-large(r5-l) (deprecated)
resizeable-large(r5-l)-v2 (deprecated)
resizeable-large(r5-xl) (deprecated)
resizeable-large(r5-xl)-v2 (deprecated)
resizeable-small(r5-2xl) (deprecated)
resizeable-small(r5-2xl)-v2 (deprecated)
resizeable-small(r5-l) (deprecated)
resizeable-small(r5-l)-v2 (deprecated)
resizeable-small(r5-xl) (deprecated)
resizeable-small(r5-xl)-v2 (deprecated)
t3.medium (deprecated)
t3.medium-v2 (deprecated)
t3.small (deprecated)
t3.small-v2 (deprecated)
Microsoft Azure [AZURE_AZ]
Node Size
D15_v2-an
L8s_v2-an
Standard_DS12_v2-1023-an
Standard_DS12_v2-2046-an
Standard_DS12_v2-512-an
Standard_DS13_v2-2046-an
Standard_DS2_v2-256-an
D15_v2 (deprecated)
Standard_DS12_v2-1023 (deprecated)
Standard_DS12_v2-2046 (deprecated)
Standard_DS12_v2-512 (deprecated)
Standard_DS13_v2-2046 (deprecated)
Standard_DS2_v2-256 (deprecated)
Google Cloud Platform [GCP]
Node Size
CAS-DEV-n1-standard-1-5
CAS-DEV-n1-standard-2-30
CAS-DEV-n1-standard-2-80
CAS-PRD-n2-highmem-16-1200
CAS-PRD-n2-highmem-16-1600
CAS-PRD-n2-highmem-16-2400
CAS-PRD-n2-highmem-16-3200
CAS-PRD-n2-highmem-16-800
CAS-PRD-n2-highmem-2-1200
CAS-PRD-n2-highmem-2-1600
CAS-PRD-n2-highmem-2-250
CAS-PRD-n2-highmem-2-400
CAS-PRD-n2-highmem-2-600
CAS-PRD-n2-highmem-2-800
CAS-PRD-n2-highmem-4-1200
CAS-PRD-n2-highmem-4-1600
CAS-PRD-n2-highmem-4-2400
CAS-PRD-n2-highmem-4-3200
CAS-PRD-n2-highmem-4-400
CAS-PRD-n2-highmem-4-600
CAS-PRD-n2-highmem-4-800
CAS-PRD-n2-highmem-8-1200
CAS-PRD-n2-highmem-8-1600
CAS-PRD-n2-highmem-8-2400
CAS-PRD-n2-highmem-8-800
CAS-PRD-n2-standard-2-120
CAS-PRD-n2-standard-2-250
CAS-PRD-n2-standard-2-400
CAS-PRD-n2-standard-2-600
CAS-PRDn2-highmem-8-3200
cassandra-production-n2-highmem-16-3000
cassandra-production-n2-highmem-4-3000
cassandra-production-n2-highmem-8-1500
cassandra-production-n2-standard-8-375
cassandra-production-n2-standard-8-750
n1-highmem-4-1600
n1-highmem-4-400
n1-highmem-4-800
n1-standard-1
n1-standard-4-1600
n1-standard-4-400
n1-standard-4-800
n1-standard-2 (deprecated)

Apache ZooKeeper [APACHE_ZOOKEEPER]

Amazon Web Services [AWS_VPC]
Node Size
ZKR-PRD-m5d.large-75
ZKR-PRD-m5d.xlarge-150
zookeeper-developer-t3.small-20
zookeeper-production-m5.large-60
zookeeper-production-m5.xlarge-120

Cadence [CADENCE]

Amazon Web Services [AWS_VPC]
Node Size
CAD-DEV-t3.medium-30
CAD-DEV-t3.small-5
CAD-PRD-m5ad.2xlarge-300
CAD-PRD-m5ad.4xlarge-600
CAD-PRD-m5ad.large-75
CAD-PRD-m5ad.xlarge-150
CAD-SI-DEV-t3.small-5
CAD-PRD-m5.large-250 (deprecated)
CAD-PRD-m5.xlarge-400 (deprecated)
Microsoft Azure [AZURE_AZ]
Node Size
CAD-DEV-standard_ds2_v2-30
CAD-PRD-standard_ds2_v2-150
CAD-PRD-standard_ds3_v2-150
Google Cloud Platform [GCP]
Node Size
CAD-DEV-n1-standard-1-30
CAD-PRD-n1-standard-2-150
CAD-PRD-n1-standard-4-150

Elasticsearch (For Legacy Support Only) [ELASTICSEARCH]

Amazon Web Services [AWS_VPC]
Node Size
SRH-DM-m5d.2xlarge
SRH-DM-m5d.large
SRH-DM-m5d.xlarge
SRH-PRD-c5d.2xlarge-200
SRH-PRD-i3.2xlarge-1769
SRH-PRD-i3en.xlarge-2328
m5l-400-v2 (deprecated)
r5xl-800-v2 (deprecated)
SRH-DEV-t3.medium-30 (deprecated)
SRH-DEV-t3.small-5 (deprecated)
SRH-DM-DEV-t3.small-5 (deprecated)
SRH-DM-t3.small-v2 (deprecated)
SRH-PRD-m5.large-250 (deprecated)
SRH-PRD-m5.xlarge-1600 (deprecated)
SRH-PRD-m5.xlarge-400 (deprecated)
SRH-PRD-m5.xlarge-800 (deprecated)
SRH-PRD-r5.xlarge-1200 (deprecated)
SRH-PRD-r5.xlarge-2000 (deprecated)
Google Cloud Platform [GCP]
Node Size
SRH-DEV-n1-standard-1-30
SRH-DEV-n1-standard-2-120
SRH-DEV-n1-standard-2-250
SRH-DEV-n1-standard-2-30
SRH-DEV-n1-standard-2-80
SRH-DM-DEV-n1-standard-1-30
SRH-DM-PRD-n1-highmem-16-128
SRH-DM-PRD-n1-standard-2-64
SRH-DM-PRD-n1-standard-4-64
SRH-DM-PRD-n1-standard-8-128
SRH-DM-PRD-n2-standard-16-128
SRH-DM-PRD-n2-standard-2-64
SRH-DM-PRD-n2-standard-4-64
SRH-DM-PRD-n2-standard-8-128
SRH-PRD-n1-highmem-16-1200
SRH-PRD-n1-highmem-16-1600
SRH-PRD-n1-highmem-16-2400
SRH-PRD-n1-highmem-16-3200
SRH-PRD-n1-highmem-16-4500
SRH-PRD-n1-highmem-16-800
SRH-PRD-n1-highmem-2-1200
SRH-PRD-n1-highmem-2-1600
SRH-PRD-n1-highmem-2-250
SRH-PRD-n1-highmem-2-400
SRH-PRD-n1-highmem-2-600
SRH-PRD-n1-highmem-2-800
SRH-PRD-n1-highmem-4-1200
SRH-PRD-n1-highmem-4-1500
SRH-PRD-n1-highmem-4-1600
SRH-PRD-n1-highmem-4-2400
SRH-PRD-n1-highmem-4-3000
SRH-PRD-n1-highmem-4-3200
SRH-PRD-n1-highmem-4-400
SRH-PRD-n1-highmem-4-600
SRH-PRD-n1-highmem-4-800
SRH-PRD-n1-highmem-8-1200
SRH-PRD-n1-highmem-8-1500
SRH-PRD-n1-highmem-8-1600
SRH-PRD-n1-highmem-8-2400
SRH-PRD-n1-highmem-8-3000
SRH-PRD-n1-highmem-8-3200
SRH-PRD-n1-highmem-8-800
SRH-PRD-n1-standard-2-120
SRH-PRD-n1-standard-2-250
SRH-PRD-n1-standard-2-400
SRH-PRD-n1-standard-2-600
SRH-PRD-n2-highmem-16-1200
SRH-PRD-n2-highmem-16-1600
SRH-PRD-n2-highmem-16-2400
SRH-PRD-n2-highmem-16-3200
SRH-PRD-n2-highmem-16-4500
SRH-PRD-n2-highmem-16-800
SRH-PRD-n2-highmem-2-1200
SRH-PRD-n2-highmem-2-1600
SRH-PRD-n2-highmem-2-250
SRH-PRD-n2-highmem-2-400
SRH-PRD-n2-highmem-2-600
SRH-PRD-n2-highmem-2-800
SRH-PRD-n2-highmem-4-1200
SRH-PRD-n2-highmem-4-1500
SRH-PRD-n2-highmem-4-1600
SRH-PRD-n2-highmem-4-2400
SRH-PRD-n2-highmem-4-3000
SRH-PRD-n2-highmem-4-3200
SRH-PRD-n2-highmem-4-400
SRH-PRD-n2-highmem-4-600
SRH-PRD-n2-highmem-4-800
SRH-PRD-n2-highmem-8-1200
SRH-PRD-n2-highmem-8-1500
SRH-PRD-n2-highmem-8-1600
SRH-PRD-n2-highmem-8-2400
SRH-PRD-n2-highmem-8-3000
SRH-PRD-n2-highmem-8-3200
SRH-PRD-n2-highmem-8-800
SRH-PRD-n2-standard-2-120
SRH-PRD-n2-standard-2-250
SRH-PRD-n2-standard-2-400
SRH-PRD-n2-standard-2-600
SRH-DM-n1-standard-1 (deprecated)
SRH-DM-n1-standard-2 (deprecated)
SRH-DM-n1-standard-4 (deprecated)
SRH-DM-n1-standard-8 (deprecated)
SRH-DM-n2-standard-2 (deprecated)
SRH-DM-n2-standard-4 (deprecated)
SRH-DM-n2-standard-8 (deprecated)

Apache Kafka [KAFKA]

Amazon Web Services [AWS_VPC]
Node Size
i3.2xlarge-1900-gp2
i3.xlarge-950-gp2
KDZ-DEV-t4g.small-30
KDZ-PRD-m6g.large-80
KDZ-PRD-m6g.xlarge-250
KDZ-PRD-m6g.xlarge-80
KFK-DEV-t4g.medium-80
KFK-DEV-t4g.small-30
KFK-DEV-t4g.small-5
KFK-DEV-t4g.small-80
KFK-PRD-i3en.2xlarge-4656
KFK-PRD-i3en.xlarge-2328
KFK-PRD-r6g.2xlarge-1200
KFK-PRD-r6g.2xlarge-1600
KFK-PRD-r6g.2xlarge-2400
KFK-PRD-r6g.2xlarge-3200
KFK-PRD-r6g.2xlarge-4500
KFK-PRD-r6g.large-1200
KFK-PRD-r6g.large-250
KFK-PRD-r6g.large-400
KFK-PRD-r6g.large-600
KFK-PRD-r6g.large-800
KFK-PRD-r6g.xlarge-1200
KFK-PRD-r6g.xlarge-1600
KFK-PRD-r6g.xlarge-2400
KFK-PRD-r6g.xlarge-800
c5.2xlarge-1500-gp2 (deprecated)
c5.4xlarge-1500-gp2 (deprecated)
c5.xlarge-750-gp2 (deprecated)
c5.xlarge-800-gp2 (deprecated)
r5.2xlarge-1500-gp2 (deprecated)
r5.2xlarge-3000-gp2 (deprecated)
r5.2xlarge-4500-gp2 (deprecated)
r5.large-500-gp2 (deprecated)
r5.large-800-gp2 (deprecated)
r5.xlarge-1500-gp2 (deprecated)
r5.xlarge-2250-gp2 (deprecated)
r5.xlarge-750-gp2 (deprecated)
r5.xlarge-800-gp2 (deprecated)
t3.medium-80-gp2 (deprecated)
t3.small-20-gp2 (deprecated)
zk-developer-t3.small-20 (deprecated)
zk-production-m5.large-60 (deprecated)
zk-production-m5.xlarge-120 (deprecated)
Microsoft Azure [AZURE_AZ]
Node Size
Standard_DS11_v2-512
Standard_DS11_v2-768
Standard_DS12_v2-1500
Standard_DS12_v2-2250
Standard_DS12_v2-768
Standard_DS13_v2-1500
Standard_DS13_v2-3000
Standard_DS13_v2-4500
Standard_DS1_v2-32
Standard_DS2_v2-64
zk-developer-DS1v2-32
zk-production-D2sv3-64
zk-production-D4sv3-128
Google Cloud Platform [GCP]
Node Size
kafka-production-n2-standard-8-1500
kafka-production-n2-standard-8-3000
kafka-production-n2-standard-8-375
kafka-production-n2-standard-8-750
n1-highmem-2-400
n1-highmem-2-800
n1-highmem-4-1500
n1-highmem-4-2250
n1-highmem-4-750
n1-highmem-8-1500
n1-highmem-8-3000
n1-highmem-8-4500
n1-standard-1-80
zk-developer-n1-standard-1-30
zk-production-n1-standard-2-60
zk-production-n1-standard-4-120

Apache Kafka Connect [KAFKA_CONNECT]

Amazon Web Services [AWS_VPC]
Node Size
KCN-DEV-t4g.medium-30
KCN-PRD-c6g.2xlarge-80
KCN-PRD-c6g.4xlarge-80
KCN-PRD-c6g.large-80
KCN-PRD-c6g.xlarge-80
KCN-PRD-r6g.2xlarge-80
KCN-PRD-r6g.4xlarge-80
KCN-PRD-r6g.large-80
KCN-PRD-r6g.xlarge-80
c5.2xlarge-20-gp2 (deprecated)
c5.4xlarge-40-gp2 (deprecated)
c5.xlarge-10-gp2 (deprecated)
r5.2xlarge-20-gp2 (deprecated)
r5.4xlarge-40-gp2 (deprecated)
r5.xlarge-10-gp2 (deprecated)
t3.medium-10-gp2 (deprecated)
Microsoft Azure [AZURE_AZ]
Node Size
Standard_D16s_v3-40
Standard_D2s_v3-10
Standard_D4s_v3-10
Standard_D8s_v3-20
Google Cloud Platform [GCP]
Node Size
n1-standard-16-40
n1-standard-2-10
n1-standard-4-10
n1-standard-8-20

OpenSearch [OPENSEARCH]

Amazon Web Services [AWS_VPC]
Node Size
SRH-DEV-t4g.medium-30
SRH-DEV-t4g.medium-80
SRH-DEV-t4g.small-30
SRH-DEV-t4g.small-5
SRH-DM-DEV-t4g.small-5
SRH-DM-m5d.2xlarge
SRH-DM-m5d.large
SRH-DM-m5d.xlarge
SRH-DM-PRD-m6g.4xlarge-10
SRH-DM-PRD-m6g.large-10
SRH-DM-PRD-m6g.xlarge-10
SRH-PRD-c5d.2xlarge-200
SRH-PRD-i3.2xlarge-1769
SRH-PRD-i3.4xlarge-3538
SRH-PRD-i3en.2xlarge-4656
SRH-PRD-i3en.xlarge-2328
SRH-PRD-m6g.large-120
SRH-PRD-m6g.large-250
SRH-PRD-m6g.large-400
SRH-PRD-m6g.large-600
SRH-PRD-r6g.2xlarge-1200
SRH-PRD-r6g.2xlarge-1600
SRH-PRD-r6g.2xlarge-2400
SRH-PRD-r6g.2xlarge-800
SRH-PRD-r6g.4xlarge-1200
SRH-PRD-r6g.4xlarge-1600
SRH-PRD-r6g.4xlarge-2400
SRH-PRD-r6g.4xlarge-3200
SRH-PRD-r6g.4xlarge-4500
SRH-PRD-r6g.4xlarge-800
SRH-PRD-r6g.large-1200
SRH-PRD-r6g.large-1600
SRH-PRD-r6g.large-250
SRH-PRD-r6g.large-400
SRH-PRD-r6g.large-600
SRH-PRD-r6g.large-800
SRH-PRD-r6g.xlarge-1200
SRH-PRD-r6g.xlarge-1600
SRH-PRD-r6g.xlarge-2400
SRH-PRD-r6g.xlarge-3200
SRH-PRD-r6g.xlarge-400
SRH-PRD-r6g.xlarge-600
SRH-PRD-r6g.xlarge-800
m5l-400-v2 (deprecated)
r5xl-800-v2 (deprecated)
SRH-DEV-t3.medium-30 (deprecated)
SRH-DEV-t3.small-5 (deprecated)
SRH-DM-DEV-t3.small-5 (deprecated)
SRH-PRD-m5.large-250 (deprecated)
SRH-PRD-m5.xlarge-1600 (deprecated)
SRH-PRD-m5.xlarge-400 (deprecated)
SRH-PRD-m5.xlarge-800 (deprecated)
SRH-PRD-r5.xlarge-1200 (deprecated)
SRH-PRD-r5.xlarge-2000 (deprecated)
Microsoft Azure [AZURE_AZ]
Node Size
SRH-DEV-D2s_v4-120-an
SRH-DEV-D2s_v4-250-an
SRH-DEV-D2s_v4-30-an
SRH-DEV-D2s_v4-80-an
SRH-DEV-D2s_v5-120-an
SRH-DEV-D2s_v5-250-an
SRH-DEV-D2s_v5-30-an
SRH-DEV-D2s_v5-80-an
SRH-DEV-DS1_v2-30-an
SRH-DEV-DS1_v2-5-an
SRH-DM-DEV-DS1_v2-5-an
SRH-DM-PRD-D2as_v4-16-an
SRH-DM-PRD-D2s_v3-16-an
SRH-DM-PRD-D4as_v4-32-an
SRH-DM-PRD-D4s_v3-32-an
SRH-DM-PRD-D8as_v4-64-an
SRH-DM-PRD-D8s_v3-64-an
SRH-PRD-D2s_v4-120-an
SRH-PRD-D2s_v4-250-an
SRH-PRD-D2s_v4-400-an
SRH-PRD-D2s_v4-600-an
SRH-PRD-D2s_v5-120-an
SRH-PRD-D2s_v5-250-an
SRH-PRD-D2s_v5-400-an
SRH-PRD-D2s_v5-600-an
SRH-PRD-D8s_v4-2000-an
SRH-PRD-D8s_v4-4000-an
SRH-PRD-D8s_v4-6000-an
SRH-PRD-E16s_v4-4000-an
SRH-PRD-E16s_v4-6000-an
SRH-PRD-E16s_v4-8000-an
SRH-PRD-E2s_v4-1200-an
SRH-PRD-E2s_v4-1600-an
SRH-PRD-E2s_v4-250-an
SRH-PRD-E2s_v4-400-an
SRH-PRD-E2s_v4-600-an
SRH-PRD-E2s_v4-800-an
SRH-PRD-E32s_v4-12000-an
SRH-PRD-E32s_v4-4000-an
SRH-PRD-E32s_v4-6000-an
SRH-PRD-E32s_v4-8000-an
SRH-PRD-E4s_v4-1200-an
SRH-PRD-E4s_v4-2000-an
SRH-PRD-E4s_v4-250-an
SRH-PRD-E4s_v4-3200-an
SRH-PRD-E4s_v4-400-an
SRH-PRD-E4s_v4-600-an
SRH-PRD-E4s_v4-800-an
SRH-PRD-E8s_v4-1200-an
SRH-PRD-E8s_v4-1600-an
SRH-PRD-E8s_v4-2000-an
SRH-PRD-E8s_v4-3200-an
SRH-PRD-E8s_v4-4000-an
SRH-PRD-E8s_v4-6000-an
SRH-PRD-E8s_v4-800-an
SRH-PRD-L8s_v2-1788-an
Standard_DS12_v2-1023-an
Standard_DS12_v2-2046-an
Standard_DS12_v2-512-an
Standard_DS13_v2-2046-an
Standard_DS2_v2-256-an
SRH-DM-D2as_v4 (deprecated)
SRH-DM-D2s_v3 (deprecated)
SRH-DM-D4as_v4 (deprecated)
SRH-DM-D4s_v3 (deprecated)
SRH-DM-D8as_v4 (deprecated)
SRH-DM-D8s_v3 (deprecated)
Google Cloud Platform [GCP]
Node Size
SRH-DEV-n1-standard-1-30
SRH-DEV-n1-standard-2-120
SRH-DEV-n1-standard-2-250
SRH-DEV-n1-standard-2-30
SRH-DEV-n1-standard-2-80
SRH-DM-DEV-n1-standard-1-30
SRH-DM-PRD-n1-highmem-16-128
SRH-DM-PRD-n1-standard-2-64
SRH-DM-PRD-n1-standard-4-64
SRH-DM-PRD-n1-standard-8-128
SRH-DM-PRD-n2-standard-16-128
SRH-DM-PRD-n2-standard-2-64
SRH-DM-PRD-n2-standard-4-64
SRH-DM-PRD-n2-standard-8-128
SRH-PRD-n1-highmem-16-1200
SRH-PRD-n1-highmem-16-1600
SRH-PRD-n1-highmem-16-2400
SRH-PRD-n1-highmem-16-3200
SRH-PRD-n1-highmem-16-4500
SRH-PRD-n1-highmem-16-800
SRH-PRD-n1-highmem-2-1200
SRH-PRD-n1-highmem-2-1600
SRH-PRD-n1-highmem-2-250
SRH-PRD-n1-highmem-2-400
SRH-PRD-n1-highmem-2-600
SRH-PRD-n1-highmem-2-800
SRH-PRD-n1-highmem-4-1200
SRH-PRD-n1-highmem-4-1500
SRH-PRD-n1-highmem-4-1600
SRH-PRD-n1-highmem-4-2400
SRH-PRD-n1-highmem-4-3000
SRH-PRD-n1-highmem-4-3200
SRH-PRD-n1-highmem-4-400
SRH-PRD-n1-highmem-4-600
SRH-PRD-n1-highmem-4-800
SRH-PRD-n1-highmem-8-1200
SRH-PRD-n1-highmem-8-1500
SRH-PRD-n1-highmem-8-1600
SRH-PRD-n1-highmem-8-2400
SRH-PRD-n1-highmem-8-3000
SRH-PRD-n1-highmem-8-3200
SRH-PRD-n1-highmem-8-800
SRH-PRD-n1-standard-2-120
SRH-PRD-n1-standard-2-250
SRH-PRD-n1-standard-2-400
SRH-PRD-n1-standard-2-600
SRH-PRD-n2-highmem-16-1200
SRH-PRD-n2-highmem-16-1600
SRH-PRD-n2-highmem-16-2400
SRH-PRD-n2-highmem-16-3200
SRH-PRD-n2-highmem-16-4500
SRH-PRD-n2-highmem-16-800
SRH-PRD-n2-highmem-2-1200
SRH-PRD-n2-highmem-2-1600
SRH-PRD-n2-highmem-2-250
SRH-PRD-n2-highmem-2-400
SRH-PRD-n2-highmem-2-600
SRH-PRD-n2-highmem-2-800
SRH-PRD-n2-highmem-4-1200
SRH-PRD-n2-highmem-4-1500
SRH-PRD-n2-highmem-4-1600
SRH-PRD-n2-highmem-4-2400
SRH-PRD-n2-highmem-4-3000
SRH-PRD-n2-highmem-4-3200
SRH-PRD-n2-highmem-4-400
SRH-PRD-n2-highmem-4-600
SRH-PRD-n2-highmem-4-800
SRH-PRD-n2-highmem-8-1200
SRH-PRD-n2-highmem-8-1500
SRH-PRD-n2-highmem-8-1600
SRH-PRD-n2-highmem-8-2400
SRH-PRD-n2-highmem-8-3000
SRH-PRD-n2-highmem-8-3200
SRH-PRD-n2-highmem-8-800
SRH-PRD-n2-standard-2-120
SRH-PRD-n2-standard-2-250
SRH-PRD-n2-standard-2-400
SRH-PRD-n2-standard-2-600
SRH-DM-n1-standard-1 (deprecated)
SRH-DM-n1-standard-2 (deprecated)
SRH-DM-n1-standard-4 (deprecated)
SRH-DM-n1-standard-8 (deprecated)
SRH-DM-n2-standard-2 (deprecated)
SRH-DM-n2-standard-4 (deprecated)
SRH-DM-n2-standard-8 (deprecated)

PostgreSQL [POSTGRESQL]

Amazon Web Services [AWS_VPC]
Node Size
PGS-DEV-t4g.medium-30
PGS-DEV-t4g.small-5
PGS-PRD-m6g.2xlarge-1000
PGS-PRD-m6g.2xlarge-2000
PGS-PRD-m6g.2xlarge-4000
PGS-PRD-m6g.2xlarge-8000
PGS-PRD-m6g.large-1000
PGS-PRD-m6g.large-250
PGS-PRD-m6g.large-500
PGS-PRD-m6g.xlarge-1000
PGS-PRD-m6g.xlarge-2000
PGS-PRD-m6g.xlarge-4000
PGS-PRD-m6g.xlarge-500
PGS-PRD-r6g.4xlarge-1000
PGS-PRD-r6g.4xlarge-2000
PGS-PRD-r6g.4xlarge-4000
PGS-PRD-r6g.4xlarge-500
PGS-DEV-t3.medium-30 (deprecated)
PGS-DEV-t3.small-5 (deprecated)
PGS-PRD-r5.2xlarge-1000 (deprecated)
PGS-PRD-r5.2xlarge-2000 (deprecated)
PGS-PRD-r5.2xlarge-4000 (deprecated)
PGS-PRD-r5.large-250 (deprecated)
PGS-PRD-r5.large-500 (deprecated)
PGS-PRD-r5.xlarge-1000 (deprecated)
PGS-PRD-r5.xlarge-2000 (deprecated)
PGS-PRD-r5.xlarge-500 (deprecated)
Microsoft Azure [AZURE_AZ]
Node Size
PGS-DEV-Standard_DS1_v2-30-an
PGS-DEV-Standard_DS1_v2-5-an
PGS-PRD-L8s_v2-1388-an
PGS-PRD-Standard_DS11_v2-250-an
PGS-PRD-Standard_DS11_v2-500-an
PGS-PRD-Standard_DS12_v2-1000-an
PGS-PRD-Standard_DS12_v2-2000-an
PGS-PRD-Standard_DS12_v2-500-an
PGS-PRD-Standard_DS13_v2-1000-an
PGS-PRD-Standard_DS13_v2-2000-an
PGS-PRD-Standard_DS13_v2-4000-an
PGS-PRD-Standard_DS2_v2-250-an
PGS-PRD-Standard_DS2_v2-500-an
Google Cloud Platform [GCP]
Node Size
PGS-DEV-n2-standard-2-30
PGS-DEV-n2-standard-2-5
PGS-PRD-n2-standard-2-250
PGS-PRD-n2-standard-4-1000
PGS-PRD-n2-standard-4-500
PGS-PRD-n2-standard-8-2000
PGS-PRD-n2-standard-8-4000

Redis [REDIS]

Amazon Web Services [AWS_VPC]
Node Size
r5.2xlarge-400-r
r5.4xlarge-600-r
r5.8xlarge-1000-r
r5.large-100-r
r5.xlarge-200-r
r6g.2xlarge-400-r
r6g.4xlarge-600-r
r6g.large-100-r
r6g.xlarge-200-r
t3.medium-80-r
t3.small-20-r
Microsoft Azure [AZURE_AZ]
Node Size
Standard_DS2_v2-64-r
Standard_E16s_v3-800-r
Standard_E2s_v3-100-r
Standard_E4s_v3-200-r
Standard_E8s_v3-400-r
Google Cloud Platform [GCP]
Node Size
n1-highmem-16-600-r
n1-highmem-2-100-r
n1-highmem-4-200-r
n1-highmem-8-400-r
n1-standard-1-30-r
clusterNetwork
string

The private network address block for the single data centre (if multiple data centres leave blank) specified using CIDR address notation. The network must have a prefix length between /12 and /22 and must be part of a private address space.

dataCentre
string

Single data centre, for multiple leave blank and use dataCentres.

Desired data centre

Amazon Web Services [AWS_VPC]

Data Centre Description
AF_SOUTH_1 Africa (Cape Town)
AP_EAST_1 Asia Pacific (Hong Kong)
AP_NORTHEAST_1 Asia Pacific (Tokyo)
AP_NORTHEAST_2 Asia Pacific (Seoul)
AP_SOUTHEAST_1 Asia Pacific (Singapore)
AP_SOUTHEAST_2 Asia Pacific (Sydney)
AP_SOUTH_1 Asia Pacific (Mumbai)
CA_CENTRAL_1 Canada (Central)
CN_NORTHWEST_1 China (Ningxia)
CN_NORTH_1 China (Beijing)
EU_CENTRAL_1 EU Central (Frankfurt)
EU_NORTH_1 EU North (Stockholm)
EU_SOUTH_1 EU South (Milan)
EU_WEST_1 EU West (Ireland)
EU_WEST_2 EU West (London)
EU_WEST_3 EU West (Paris)
ME_SOUTH_1 Middle East (Bahrain)
SA_EAST_1 South America (São Paulo)
US_EAST_1 US East (Northern Virginia)
US_EAST_2 US East (Ohio)
US_WEST_1 US West (Northern California)
US_WEST_2 US West (Oregon)

Microsoft Azure [AZURE_AZ]

Data Centre Description
AUSTRALIA_EAST Australia East (NSW)
CANADA_CENTRAL Canada Central (Toronto)
CENTRAL_US Central US (Iowa)
EAST_US East US (Virginia)
EAST_US_2 East US 2 (Virginia)
NORTH_EUROPE North Europe (Ireland)
SOUTHEAST_ASIA Southeast Asia (Singapore)
SOUTH_CENTRAL_US South Central US (Texas)
WEST_EUROPE West Europe (Netherlands)
WEST_US_2 West US 2 (Washington)

Google Cloud Platform [GCP]

Data Centre Description
asia-east1 Eastern Asia-Pacific (Taiwan)
asia-northeast1 Northeastern Asia-pacific (Japan)
asia-south1 Southern Asia (India)
asia-southeast1 Southeastern Asia (Singapore)
australia-southeast1 Southeastern Australia (Sydney)
europe-north1 Northern Europe (Finland)
europe-west1 Western Europe (Belgium)
europe-west2 Western Europe (England)
europe-west3 Western Europe (Germany)
europe-west4 Western Europe (Netherlands)
europe-west6 Western Europe (Zurich)
northamerica-northeast1 Northeastern North America (Canada)
southamerica-east1 Eastern South America (Brazil)
us-central1 Central US (Iowa)
us-east1 Eastern US (South Carolina)
us-east4 Eastern US (North Virginia)
us-west1 Western US (Oregon)
us-west2 Western US (California)

dataCentreCustomName
string

Optional. Assign a custom name for the data centre when creating a cluster with a single data centre.

For clusters with multiple data centres use dataCentres.name instead

Array of objects (DataCentreRequest)
object (RackAllocation)
Array of objects (FirewallRule)
object (TwoFactorDeleteConfiguration)

If present, deleteVerifyEmail or/and deleteVerifyPhone must be included in the request

oidcProvider
string
bundledUseOnlyCluster
boolean
Responses
202

Request accepted

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.

post/provisioning/v1/extended
Request samples
application/json

Apache Cassandra - PCI compliant

{
  • "bundles": [
    ],
  • "clusterName": "cassandra-pci-cluster",
  • "clusterNetwork": "192.168.0.0/18",
  • "dataCentre": "US_WEST_2",
  • "firewallRules": [
    ],
  • "nodeSize": "m5l-250-v2",
  • "pciCompliantCluster": "true",
  • "privateNetworkCluster": "true",
  • "provider": {
    },
  • "rackAllocation": {
    },
  • "slaTier": "NON_PRODUCTION"
}
Response samples
application/json
{
  • "id": "77b5a4e1-c422-4a78-b551-d8fa5c42ad95"
}

Retrieve active clusters

Retrieve a list of all active clusters in your account

SecurityBasic Authentication
Responses
200

All active clusters on account

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
Request samples
Response samples
application/json
[
  • {
    }
]

Cluster status

Retrieve the current status of a cluster

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: ba74ca2b-7fc0-4487-a9d8-037823144753
Responses
202

Cluster status

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/{clusterId}
Request samples
Response samples
application/json
{
  • "id": "77b5a4e1-c422-4a78-b551-d8fa5c42ad95",
  • "clusterName": "instaclustr-test-cluster",
  • "clusterStatus": "RUNNING",
  • "cassandraVersion": "3.11.4",
  • "username": "iccassandra",
  • "instaclustrUserPassword": "supersecretpassword",
  • "slaTier": "PRODUCTION",
  • "clusterCertificateDownload": "disabled",
  • "pciCompliance": "ENABLED",
  • "tags": {
    },
  • "dataCentres": [
    ]
}

Modify Cluster

Make an update to an active cluster's settings.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Request Body schema: application/json
object (TwoFactorDeleteConfiguration)

If present, deleteVerifyEmail or/and deleteVerifyPhone must be included in the request

description
string

A description of the cluster.

Responses
200

The cluster has been successfully updated

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.

put/provisioning/v1/{clusterId}
Request samples
application/json
{
  • "twoFactorDelete": {
    },
  • "description": "My cluster containing highly available data."
}
Response samples
application/json
{
  • "message": "The cluster has been successfully updated."
}

Delete cluster

Delete an existing cluster

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: ba74ca2b-7fc0-4487-a9d8-037823144753
Responses
202

Cluster has been marked for deletion.

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

409

The cluster delete request failed due to other clusters depending on this cluster

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.

delete/provisioning/v1/{clusterId}
Request samples
Response samples
application/json
{
  • "message": "Cluster has been marked for deletion."
}

Cluster status for Terraform Import

Retrieve the current status of a cluster with additional fields to be compatible with terraform imports

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: ba74ca2b-7fc0-4487-a9d8-037823144753
Responses
200

Cluster status

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/{clusterId}/terraform-description
Request samples
Response samples
application/json
{
  • "id": "77b5a4e1-c422-4a78-b551-d8fa5c42ad95",
  • "clusterName": "instaclustr-test-cluster",
  • "clusterStatus": "RUNNING",
  • "bundleType": "APACHE_CASSANDRA",
  • "bundleVersion": "3.11.8",
  • "bundleOptions": {
    },
  • "addonBundles": [
    ],
  • "clusterProvider": [
    ],
  • "username": "iccassandra",
  • "instaclustrUserPassword": "supersecretpassword",
  • "slaTier": "PRODUCTION",
  • "clusterCertificateDownload": "disabled",
  • "pciCompliance": "ENABLED",
  • "dataCentres": [
    ],
  • "twoFactorDelete": false,
  • "oidcId": "string",
  • "cdcid": "77b5a4e1-c422-4a78-b551-d8fa5c42ad95"
}

Download certificate

Download cluster X.509 Certificate Authority certificates

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 77b5a4e1-c422-4a78-b551-d8fa5c42ad95
Responses
200

Download certificates

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/{clusterId}/certificate
Request samples
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "errorDetails": { },
  • "code": 0,
  • "link": "string"
}

Sync kafka connectors

Update kafka connect cluster to use custom kafka connector. See Updating custom connectors

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 77b5a4e1-c422-4a78-b551-d8fa5c42ad95
Responses
200

Successfully submitted request to update custom connectors

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.

post/provisioning/v1/{clusterId}/customConnectors/sync
Request samples
Response samples
application/json
{
  • "status": "Successfully submitted request to update custom connectors"
}

Get cluster events

Lists events related to cluster provisioning. Events ordered from latest to earliest. Currently only supports events related to provisioning failures.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 77b5a4e1-c422-4a78-b551-d8fa5c42ad95
Responses
200

Successfully returned cluster events

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/{clusterId}/events
Request samples
Response samples
application/json
[
  • {
    }
]