Apache Cassandra Provisioning V2

List recent cluster backup events.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the cluster.

Responses
200

List backups and restores for each node in a given cluster, for the last 7 days.

get/cluster-management/v2/data-sources/applications/cassandra/clusters/v2/{clusterId}/list-backups/v2
Request samples
Response samples
application/json
{
  • "clusterDataCentres": [
    ],
  • "id": "77b5a4e1-c422-4a78-b551-d8fa5c42ad95",
  • "name": "example-cluster"
}

List compatible node sizes for Cassandra and any specified addon applications.

SecurityBasic Authentication
Request
query Parameters
sparkRequired
boolean

Specifies whether node sizes are also compatible with Spark.

cassandraVersion
string[0-9]+\.[0-9]+\.[0-9]+

A version of Cassandra to further filter compatible node sizes.

Responses
200

Successfully retrieved compatible node sizes for Cassandra.

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

List all versions of applications compatible with a Cassandra version.

SecurityBasic Authentication
Request
path Parameters
version
required
string[0-9]+\.[0-9]+\.[0-9]+

A Cassandra version.

Responses
200

Successfully retrieved versions of applications compatible with a Cassandra version.

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

List all Cassandra applications and versions.

SecurityBasic Authentication
Responses
200

Successfully retrieved applications and versions for Cassandra.

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

Download Cassandra cluster X.509 Certificate Authority certificates

Cassandra 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 Cassandra cluster's certificate

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

Manually trigger cluster backup.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the cluster.

Responses
202

Trigger cluster backup request accepted.

post/cluster-management/v2/operations/applications/cassandra/clusters/v2/{clusterId}/trigger-backup/v2
Request samples

Trigger a Cassandra Cluster Restore

SecurityBasic Authentication
Request
Request Body schema: application/json
required
Array of objects (ClusterDataCentreRestoreConfigV2)

An optional list of Cluster Data Centres to determine their VPC in the restored cluster.

Data centres not included will default to being restored to a new VPC.

keyspaceTables
string

A comma separated list of keyspace/table names which follows the format <keyspace>.<table1>,<keyspace>.<table2>

pointInTime
string

Timestamp in milliseconds since epoch or ISO formatted date and time (example - 2023-11-05T13:15:30Z). All backed up data will be restored for this point in time.

Defaults to the current date and time.

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

The display name of the restored cluster.

By default, the restored cluster will be created with its current name appended with “restored” and the date & time it was requested to be restored.

clusterNetwork
string

The cluster network for this cluster to be restored to.

clusterId
required
string <uuid>

ID of the cluster

Responses
202

Cassandra Cluster Restore requested

post/cluster-management/v2/operations/applications/cassandra/restore/v2
Request samples
application/json
{
  • "cdcConfigs": [
    ],
  • "clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
  • "clusterNetwork": "10.0.0.0/16",
  • "keyspaceTables": "keyspace1.test1,keyspace1.test2",
  • "pointInTime": 1420070400000,
  • "restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
  • "restoredClusterName": "my-restored-cluster"
}
Response samples
application/json
{
  • "cdcConfigs": [
    ],
  • "clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
  • "clusterNetwork": "10.0.0.0/16",
  • "keyspaceTables": "keyspace1.test1,keyspace1.test2",
  • "pointInTime": 1420070400000,
  • "restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
  • "restoredClusterName": "my-restored-cluster"
}

Create a Cassandra cluster.

SecurityBasic Authentication
Request
Request Body schema: application/json
required
pciComplianceMode
required
boolean

Creates a PCI compliant cluster, see PCI Compliance.

description
string

A description of the cluster

Array of objects (TwoFactorDeleteSettingsV2) <= 1 items
required
Array of objects (CassandraDataCentreV2) non-empty

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"
privateNetworkCluster
required
boolean

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

cassandraVersion
required
string[0-9]+\.[0-9]+\.[0-9]+

Version of Cassandra to run on the cluster. Available versions:

  • 4.1.5
  • 4.1.6
  • 5.0.0
  • 3.11.17
  • 4.0.13
  • 4.0.12

luceneEnabled
required
boolean

Adds Apache Lucene to the Cassandra cluster.

passwordAndUserAuth
required
boolean

Enables Password Authentication and User Authorization.

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

Name of the cluster.

bundledUseOnly
boolean

Provision this cluster for Bundled Use only.

Array of objects (ResizeSettingsV2) <= 1 items

Settings to determine how resize requests will be performed for the cluster.

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

Cassandra Cluster provisioning requested.

post/cluster-management/v2/resources/applications/cassandra/clusters/v2
Request samples
application/json
{
  • "cassandraVersion": "[x.y.z]",
  • "dataCentres": [
    ],
  • "luceneEnabled": true,
  • "name": "MyTestCluster",
  • "passwordAndUserAuth": true,
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "twoFactorDelete": [
    ]
}
Response samples
application/json
{
  • "cassandraVersion": "[x.y.z]",
  • "dataCentres": [
    ],
  • "luceneEnabled": true,
  • "name": "MyTestCluster",
  • "passwordAndUserAuth": true,
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "twoFactorDelete": [
    ]
}

Get Cassandra cluster details.

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

Cassandra cluster details retrieved.

get/cluster-management/v2/resources/applications/cassandra/clusters/v2/{clusterId}
Request samples
Response samples
application/json
{
  • "cassandraVersion": "[x.y.z]",
  • "dataCentres": [
    ],
  • "luceneEnabled": true,
  • "name": "MyTestCluster",
  • "passwordAndUserAuth": true,
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "twoFactorDelete": [
    ]
}

Update Cassandra Cluster Details

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects (CassandraDataCentreV2) non-empty

List of datacentre settings.

description
string

A description of the cluster

Array of objects (TwoFactorDeleteSettingsV2) <= 1 items
Array of objects (ResizeSettingsV2) <= 1 items

Settings to determine how resize requests will be performed for the cluster.

Responses
202

Cassandra cluster update request accepted.

404

Cassandra cluster not found

put/cluster-management/v2/resources/applications/cassandra/clusters/v2/{clusterId}
Request samples
application/json
{
  • "dataCentres": [
    ],
  • "description": "Cluster managed by the integration team.",
  • "twoFactorDelete": [
    ],
  • "resizeSettings": [
    ]
}
Response samples
application/json
{
  • "cassandraVersion": "[x.y.z]",
  • "dataCentres": [
    ],
  • "luceneEnabled": true,
  • "name": "MyTestCluster",
  • "passwordAndUserAuth": true,
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "twoFactorDelete": [
    ]
}

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/cassandra/clusters/v2/{clusterId}
Request samples