Instaclustr Logo
Powered by Redocly

Cadence Provisioning V2

List compatible node sizes for Cadence.

SecurityBasic Authentication
Responses
200

Successfully retrieved compatible node sizes for Cadence.

get/cluster-management/v2/data-sources/applications/cadence/compatible-node-sizes/v2/
Request samples 
Response samples 
application/json
[
  • {
    }
]
List all Cadence versions.
SecurityBasic Authentication 
Responses 
200
Successfully retrieved versions of Cadence.


get/cluster-management/v2/data-sources/applications/cadence/versions/v2/
Request samples 
Response samples 
application/json
[
  • {
    }
]
Download Cadence cluster X.509 Certificate Authority certificates
Cadence 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 Cadence cluster's certificate


get/cluster-management/v2/operations/applications/cadence/clusters/v2/{clusterId}/certificate/v2/
Request samples 
Create a Cadence cluster
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
pciComplianceMode
required
boolean
Creates a PCI compliant cluster, see PCI Compliance.


 
Array of objects (CadenceDependencyV2)   <= 1 items 
Supporting Primary Cadence info for Multi region Cadence.


 
Array of objects (CadenceSharedProvisioningV2)   <= 1 items 
Settings for SHARED provisioning. Must not be defined with STANDARD provisioning options. Can only use node sizes with prefix CAD-SI.


 
useHttpApi
boolean
Enable Cadence HTTP API


 
description
string
A description of the cluster


 
Array of objects (TwoFactorDeleteSettingsV2)   <= 1 items 
 
useCadenceWebAuth
required
boolean
Enable Authentication for Cadence Web


 
required
Array of objects (CadenceDataCentreV2) 
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"  
cadenceVersion
required
string[0-9]+\.[0-9]+\.[0-9]+
Version of Cadence to run on the cluster. Available versions: 
     
  • 1.2.2
    •  


 
Array of objects (CadenceStandardProvisioningV2)   <= 1 items 
Settings for STARDARD provisioning. Must not be defined with SHARED provisioning options. Can not use node sizes with prefix CAD-SI.


 
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.


 
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"  
Array of objects (AwsArchivalV2)   <= 1 items 
Cadence AWS Archival settings


 
Responses 
202
Cadence Cluster provisioning requested.


post/cluster-management/v2/resources/applications/cadence/clusters/v2/
Request samples 
application/json
{
  • "cadenceVersion": "1.2.2",
  • "dataCentres": [
    ],
  • "name": "MyCadenceCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "standardProvisioning": [
    ],
  • "useCadenceWebAuth": true,
  • "useHttpApi": false
}
Response samples 
application/json
{
  • "cadenceVersion": "1.2.2",
  • "dataCentres": [
    ],
  • "name": "MyCadenceCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "standardProvisioning": [
    ],
  • "useCadenceWebAuth": true,
  • "useHttpApi": false
}
Get Cadence cluster details.
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
Id of the active cluster


 
Responses 
200
Cadence cluster details retrieved.


get/cluster-management/v2/resources/applications/cadence/clusters/v2/{clusterId}
Request samples 
Response samples 
application/json
{
  • "cadenceVersion": "1.2.2",
  • "dataCentres": [
    ],
  • "name": "MyCadenceCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "standardProvisioning": [
    ],
  • "useCadenceWebAuth": true,
  • "useHttpApi": false
}
Update a Cadence cluster
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
Id of the active cluster


 
Request Body schema: application/json
required
required
Array of objects (CadenceDataCentreV2)   = 1 items 
List of data centre 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
Cadence cluster update request accepted.


404
Cadence cluster not found.


put/cluster-management/v2/resources/applications/cadence/clusters/v2/{clusterId}
Request samples 
application/json
{
  • "dataCentres": [
    ],
  • "description": "Cluster managed by the integration team.",
  • "twoFactorDelete": [
    ],
  • "resizeSettings": [
    ]
}
Response samples 
application/json
{
  • "cadenceVersion": "1.2.2",
  • "dataCentres": [
    ],
  • "name": "MyCadenceCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "standardProvisioning": [
    ],
  • "useCadenceWebAuth": true,
  • "useHttpApi": false
}
Delete cluster
Delete an active cluster


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
Id of the active cluster


 
Responses 
204
Cluster delete requested.


delete/cluster-management/v2/resources/applications/cadence/clusters/v2/{clusterId}
Request samples 
➔ Next to ClickHouse Integrations