Redis Cluster V2

Create a Redis Cluster

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

Enables Client ⇄ Node Encryption.

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

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

  • 6.2.7
  • 7.0.5

pciComplianceMode
required
boolean

Creates a PCI compliant cluster, see PCI Compliance.

required
Array of objects (RedisDataCentreV2) [ 1 .. 2 ] 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"
privateNetworkCluster
required
boolean

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

passwordAndUserAuth
required
boolean

Enables Password Authentication and User Authorization.

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

Name 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

Redis Cluster provisioning requested.

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

Get Redis cluster details.

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

Redis cluster details retrieved.

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

Update Redis Cluster Details

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

List of datacentre settings.

Responses
202

Redis cluster update request accepted.

404

Redis cluster not found

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

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