Apache Zookeeper Provisioning V2

List compatible node sizes for Zookeeper.

SecurityBasic Authentication
Responses
200

Successfully retrieved compatible node sizes for Zookeeper.

get/cluster-management/v2/data-sources/applications/zookeeper/compatible-node-sizes/v2/
Request samples
Response samples
application/json
[
  • {
    }
]

List all Zookeeper versions.

SecurityBasic Authentication
Responses
200

Successfully retrieved versions for Zookeeper.

get/cluster-management/v2/data-sources/applications/zookeeper/versions/v2/
Request samples
Response samples
application/json
[
  • {
    }
]

Download Zookeeper cluster X.509 Certificate Authority certificates

Zookeeper cluster certificates are returned as a .zip file. The file contains an X.509 cluster Certificate Authority certificate in JKS file, an X.509 cluster Certificate Authority certificate in PEM-encoded (ASCII) format, and an X.509 cluster Certificate Authority certificate in DER-encoded (binary) format.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string

ID of the cluster

Responses
200

Successfully create the Zookeeper cluster's certificate

get/cluster-management/v2/operations/applications/zookeeper/clusters/v2/{clusterId}/certificate/v2/
Request samples

Create a Zookeeper cluster.

SecurityBasic Authentication
Request
Request Body schema: application/json
required
required
Array of objects (ApacheZookeeperDataCentreV2) = 1 items

List of data centre settings.

currentClusterOperationStatus
string (CurrentClusterOperationStatusV2)

Indicates if the cluster is currently performing any restructuring operation such as being created or resized

Enum: "NO_OPERATION" "OPERATION_IN_PROGRESS" "OPERATION_FAILED"
zookeeperVersion
required
string[0-9]+\.[0-9]+\.[0-9]+

Version of Apache Zookeeper to run on the cluster. Available versions:

  • 3.8.4

privateNetworkCluster
required
boolean

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

name
required
string [ 3 .. 48 ] characters [a-zA-Z0-9][a-zA-Z0-9_-]*

Name of the cluster.

description
string

A description of the cluster

Array of objects (TwoFactorDeleteSettingsV2) <= 1 items
slaTier
required
string (SlaTierV2)

SLA Tier of the cluster. Non-production clusters may receive lower priority support and reduced SLAs. Production tier is not available when using Developer class nodes. See SLA Tier for more information.

Enum: "PRODUCTION" "NON_PRODUCTION"
Responses
202

Zookeeper Cluster provisioning requested.

post/cluster-management/v2/resources/applications/zookeeper/clusters/v2
Request samples
application/json
{
  • "dataCentres": [
    ],
  • "name": "MyZookeeperCluster",
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "zookeeperVersion": "[x.y.z]"
}
Response samples
application/json
{
  • "dataCentres": [
    ],
  • "name": "MyZookeeperCluster",
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "zookeeperVersion": "[x.y.z]"
}

Get Zookeeper cluster details.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Responses
200

Zookeeper cluster details retrieved.

get/cluster-management/v2/resources/applications/zookeeper/clusters/v2/{clusterId}
Request samples
Response samples
application/json
{
  • "dataCentres": [
    ],
  • "name": "MyZookeeperCluster",
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "zookeeperVersion": "[x.y.z]"
}

Delete cluster

Delete an active cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Responses
204

Cluster delete requested.

delete/cluster-management/v2/resources/applications/zookeeper/clusters/v2/{clusterId}
Request samples