Instaclustr Logo
Powered by Redocly

Valkey 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/valkey/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 Valkey.
SecurityBasic Authentication 
Responses 
200
Successfully retrieved compatible node sizes for Valkey.


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


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


get/cluster-management/v2/operations/applications/valkey/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/valkey/clusters/v2/{clusterId}/trigger-backup/v2/
Request samples 
Trigger a Valkey 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.


 
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.


 
clusterId
required
string <uuid> 
ID of the cluster


 
Responses 
202
Valkey Cluster Restore requested


post/cluster-management/v2/operations/applications/valkey/restore/v2
Request samples 
application/json
{
  • "cdcConfigs": [
    ],
  • "clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
  • "pointInTime": 1420070400000,
  • "restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
  • "restoredClusterName": "my-restored-cluster"
}
Response samples 
application/json
{
  • "cdcConfigs": [
    ],
  • "clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
  • "pointInTime": 1420070400000,
  • "restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
  • "restoredClusterName": "my-restored-cluster"
}
Create a Valkey Cluster
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
clientToNodeEncryption
required
boolean
Enables Client ⇄ Node Encryption.


 
pciComplianceMode
required
boolean
Creates a PCI compliant cluster, see PCI Compliance.


 
valkeyVersion
required
string[0-9]+\.[0-9]+\.[0-9]+
Version of Valkey to run on the cluster. Available versions: 
     
  • 7.2.5
    •  


 
description
string
A description of the cluster


 
Array of objects (TwoFactorDeleteSettingsV2)   <= 1 items 
 
required
Array of objects (ValkeyDataCentreV2)   [ 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 .. 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"  
Responses 
202
Valkey Cluster provisioning requested.


post/cluster-management/v2/resources/applications/valkey/clusters/v2
Request samples 
application/json
{
  • "clientToNodeEncryption": true,
  • "dataCentres": [
    ],
  • "name": "MyTestCluster",
  • "passwordAndUserAuth": true,
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "valkeyVersion": "[x.y.z]"
}
Response samples 
application/json
{
  • "clientToNodeEncryption": true,
  • "dataCentres": [
    ],
  • "name": "MyTestCluster",
  • "passwordAndUserAuth": true,
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "valkeyVersion": "[x.y.z]"
}
Get Valkey cluster details.
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
Responses 
200
Valkey cluster details retrieved.


get/cluster-management/v2/resources/applications/valkey/clusters/v2/{clusterId}
Request samples 
Response samples 
application/json
{
  • "clientToNodeEncryption": true,
  • "dataCentres": [
    ],
  • "name": "MyTestCluster",
  • "passwordAndUserAuth": true,
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "valkeyVersion": "[x.y.z]"
}
Update Valkey Cluster Details
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
Request Body schema: application/json
required
required
Array of objects (ValkeyDataCentreV2)   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
Valkey cluster update request accepted.


404
Valkey cluster not found


put/cluster-management/v2/resources/applications/valkey/clusters/v2/{clusterId}
Request samples 
application/json
{
  • "dataCentres": [
    ],
  • "description": "Cluster managed by the integration team.",
  • "twoFactorDelete": [
    ],
  • "resizeSettings": [
    ]
}
Response samples 
application/json
{
  • "clientToNodeEncryption": true,
  • "dataCentres": [
    ],
  • "name": "MyTestCluster",
  • "passwordAndUserAuth": true,
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "valkeyVersion": "[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/valkey/clusters/v2/{clusterId}
Request samples 
➔ Next to Valkey User V2