Clone a cluster from a full backup by creating a new cluster with the restore annotation
curl --request POST \
--url http://localhost:3001/api/clusters/{clusterName}/restores/clone \
--header 'Content-Type: application/json' \
--cookie token= \
--data '
{
"newClusterName": "<string>",
"backupName": "<string>",
"backupNamespace": "<string>",
"volumeRestorePolicy": "Parallel",
"restoreTime": "<string>"
}
'import requests
url = "http://localhost:3001/api/clusters/{clusterName}/restores/clone"
payload = {
"newClusterName": "<string>",
"backupName": "<string>",
"backupNamespace": "<string>",
"volumeRestorePolicy": "Parallel",
"restoreTime": "<string>"
}
headers = {
"cookie": "token=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'token=', 'Content-Type': 'application/json'},
body: JSON.stringify({
newClusterName: '<string>',
backupName: '<string>',
backupNamespace: '<string>',
volumeRestorePolicy: 'Parallel',
restoreTime: '<string>'
})
};
fetch('http://localhost:3001/api/clusters/{clusterName}/restores/clone', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/clusters/{clusterName}/restores/clone",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'newClusterName' => '<string>',
'backupName' => '<string>',
'backupNamespace' => '<string>',
'volumeRestorePolicy' => 'Parallel',
'restoreTime' => '<string>'
]),
CURLOPT_COOKIE => "token=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/api/clusters/{clusterName}/restores/clone"
payload := strings.NewReader("{\n \"newClusterName\": \"<string>\",\n \"backupName\": \"<string>\",\n \"backupNamespace\": \"<string>\",\n \"volumeRestorePolicy\": \"Parallel\",\n \"restoreTime\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "token=")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3001/api/clusters/{clusterName}/restores/clone")
.header("cookie", "token=")
.header("Content-Type", "application/json")
.body("{\n \"newClusterName\": \"<string>\",\n \"backupName\": \"<string>\",\n \"backupNamespace\": \"<string>\",\n \"volumeRestorePolicy\": \"Parallel\",\n \"restoreTime\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/clusters/{clusterName}/restores/clone")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["cookie"] = 'token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"newClusterName\": \"<string>\",\n \"backupName\": \"<string>\",\n \"backupNamespace\": \"<string>\",\n \"volumeRestorePolicy\": \"Parallel\",\n \"restoreTime\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"namespace": "<string>",
"state": "Pending",
"replicas": 123,
"version": "<string>",
"creationTimestamp": "<string>",
"topology": "standalone",
"componentDefinition": "<string>",
"tls": true,
"terminationPolicy": "DoNotTerminate",
"resources": {
"limits": {
"cpu": "<string>",
"memory": "<string>"
},
"requests": {
"cpu": "<string>",
"memory": "<string>"
}
},
"persistence": {
"enabled": true,
"storageClass": "<string>",
"size": "<string>",
"accessMode": "<string>"
},
"services": [
{
"name": "<string>",
"serviceType": "ClusterIP",
"annotations": {},
"podService": true
}
],
"modules": {
"falkordb": {
"config": {
"THREAD_COUNT": "<string>",
"CACHE_SIZE": "<string>",
"OMP_THREAD_COUNT": "<string>",
"NODE_CREATION_BUFFER": "<string>",
"BOLT_PORT": "<string>",
"MAX_QUEUED_QUERIES": "<string>",
"TIMEOUT_MAX": "<string>",
"TIMEOUT_DEFAULT": "<string>",
"RESULTSET_SIZE": "<string>",
"QUERY_MEM_CAPACITY": "<string>",
"VKEY_MAX_ENTITY_COUNT": "<string>",
"EFFECTS_THRESHOLD": "<string>",
"CMD_INFO": "<string>",
"MAX_INFO_QUERIES": "<string>",
"DELTA_MAX_PENDING_CHANGES": "<string>",
"IMPORT_FOLDER": "<string>"
}
}
},
"falkordbArgs": {
"THREAD_COUNT": "<string>",
"CACHE_SIZE": "<string>",
"OMP_THREAD_COUNT": "<string>",
"NODE_CREATION_BUFFER": "<string>",
"BOLT_PORT": "<string>",
"MAX_QUEUED_QUERIES": "<string>",
"TIMEOUT_MAX": "<string>",
"TIMEOUT_DEFAULT": "<string>",
"RESULTSET_SIZE": "<string>",
"QUERY_MEM_CAPACITY": "<string>",
"VKEY_MAX_ENTITY_COUNT": "<string>",
"EFFECTS_THRESHOLD": "<string>",
"CMD_INFO": "<string>",
"MAX_INFO_QUERIES": "<string>",
"DELTA_MAX_PENDING_CHANGES": "<string>",
"IMPORT_FOLDER": "<string>"
},
"sentinel": {
"enabled": true,
"replicas": 2,
"componentDefinition": "<string>",
"resources": {
"limits": {
"cpu": "<string>",
"memory": "<string>"
},
"requests": {
"cpu": "<string>",
"memory": "<string>"
}
},
"persistence": {
"enabled": true,
"storageClass": "<string>",
"size": "<string>",
"accessMode": "<string>"
},
"services": [
{
"name": "<string>",
"serviceType": "ClusterIP",
"annotations": {},
"podService": true
}
],
"schedulingPolicy": {
"nodeSelector": {},
"tolerations": [
{
"key": "<string>",
"operator": "Equal",
"value": "<string>",
"effect": "NoSchedule",
"tolerationSeconds": 1
}
]
}
},
"sharding": {
"enabled": true,
"shardCount": 4,
"replicas": 3,
"resources": {
"limits": {
"cpu": "<string>",
"memory": "<string>"
},
"requests": {
"cpu": "<string>",
"memory": "<string>"
}
},
"persistence": {
"enabled": true,
"storageClass": "<string>",
"size": "<string>",
"accessMode": "<string>"
},
"services": [
{
"name": "<string>",
"serviceType": "ClusterIP",
"annotations": {},
"podService": true
}
],
"schedulingPolicy": {
"nodeSelector": {},
"tolerations": [
{
"key": "<string>",
"operator": "Equal",
"value": "<string>",
"effect": "NoSchedule",
"tolerationSeconds": 1
}
]
}
},
"externalDomain": "<string>",
"labels": {},
"annotations": {},
"status": {
"state": "<string>",
"ready": true,
"replicas": 123,
"readyReplicas": 123,
"conditions": [
{
"type": "<string>",
"status": "<string>",
"reason": "<string>",
"message": "<string>",
"lastTransitionTime": "<string>"
}
]
}
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}Restores
Clone a cluster from a full backup by creating a new cluster with the restore annotation
Clone a cluster from a full backup by creating a new cluster with the restore annotation. With restoreTime, the new cluster is restored to that point in time from a continuous (AOF) backup instead; a time outside the window from GET /window, or a sharded continuous backup that archived a different shard count than the source has now, is a 400.
POST
/
api
/
clusters
/
{clusterName}
/
restores
/
clone
Clone a cluster from a full backup by creating a new cluster with the restore annotation
curl --request POST \
--url http://localhost:3001/api/clusters/{clusterName}/restores/clone \
--header 'Content-Type: application/json' \
--cookie token= \
--data '
{
"newClusterName": "<string>",
"backupName": "<string>",
"backupNamespace": "<string>",
"volumeRestorePolicy": "Parallel",
"restoreTime": "<string>"
}
'import requests
url = "http://localhost:3001/api/clusters/{clusterName}/restores/clone"
payload = {
"newClusterName": "<string>",
"backupName": "<string>",
"backupNamespace": "<string>",
"volumeRestorePolicy": "Parallel",
"restoreTime": "<string>"
}
headers = {
"cookie": "token=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'token=', 'Content-Type': 'application/json'},
body: JSON.stringify({
newClusterName: '<string>',
backupName: '<string>',
backupNamespace: '<string>',
volumeRestorePolicy: 'Parallel',
restoreTime: '<string>'
})
};
fetch('http://localhost:3001/api/clusters/{clusterName}/restores/clone', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/clusters/{clusterName}/restores/clone",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'newClusterName' => '<string>',
'backupName' => '<string>',
'backupNamespace' => '<string>',
'volumeRestorePolicy' => 'Parallel',
'restoreTime' => '<string>'
]),
CURLOPT_COOKIE => "token=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/api/clusters/{clusterName}/restores/clone"
payload := strings.NewReader("{\n \"newClusterName\": \"<string>\",\n \"backupName\": \"<string>\",\n \"backupNamespace\": \"<string>\",\n \"volumeRestorePolicy\": \"Parallel\",\n \"restoreTime\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "token=")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3001/api/clusters/{clusterName}/restores/clone")
.header("cookie", "token=")
.header("Content-Type", "application/json")
.body("{\n \"newClusterName\": \"<string>\",\n \"backupName\": \"<string>\",\n \"backupNamespace\": \"<string>\",\n \"volumeRestorePolicy\": \"Parallel\",\n \"restoreTime\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/clusters/{clusterName}/restores/clone")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["cookie"] = 'token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"newClusterName\": \"<string>\",\n \"backupName\": \"<string>\",\n \"backupNamespace\": \"<string>\",\n \"volumeRestorePolicy\": \"Parallel\",\n \"restoreTime\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"namespace": "<string>",
"state": "Pending",
"replicas": 123,
"version": "<string>",
"creationTimestamp": "<string>",
"topology": "standalone",
"componentDefinition": "<string>",
"tls": true,
"terminationPolicy": "DoNotTerminate",
"resources": {
"limits": {
"cpu": "<string>",
"memory": "<string>"
},
"requests": {
"cpu": "<string>",
"memory": "<string>"
}
},
"persistence": {
"enabled": true,
"storageClass": "<string>",
"size": "<string>",
"accessMode": "<string>"
},
"services": [
{
"name": "<string>",
"serviceType": "ClusterIP",
"annotations": {},
"podService": true
}
],
"modules": {
"falkordb": {
"config": {
"THREAD_COUNT": "<string>",
"CACHE_SIZE": "<string>",
"OMP_THREAD_COUNT": "<string>",
"NODE_CREATION_BUFFER": "<string>",
"BOLT_PORT": "<string>",
"MAX_QUEUED_QUERIES": "<string>",
"TIMEOUT_MAX": "<string>",
"TIMEOUT_DEFAULT": "<string>",
"RESULTSET_SIZE": "<string>",
"QUERY_MEM_CAPACITY": "<string>",
"VKEY_MAX_ENTITY_COUNT": "<string>",
"EFFECTS_THRESHOLD": "<string>",
"CMD_INFO": "<string>",
"MAX_INFO_QUERIES": "<string>",
"DELTA_MAX_PENDING_CHANGES": "<string>",
"IMPORT_FOLDER": "<string>"
}
}
},
"falkordbArgs": {
"THREAD_COUNT": "<string>",
"CACHE_SIZE": "<string>",
"OMP_THREAD_COUNT": "<string>",
"NODE_CREATION_BUFFER": "<string>",
"BOLT_PORT": "<string>",
"MAX_QUEUED_QUERIES": "<string>",
"TIMEOUT_MAX": "<string>",
"TIMEOUT_DEFAULT": "<string>",
"RESULTSET_SIZE": "<string>",
"QUERY_MEM_CAPACITY": "<string>",
"VKEY_MAX_ENTITY_COUNT": "<string>",
"EFFECTS_THRESHOLD": "<string>",
"CMD_INFO": "<string>",
"MAX_INFO_QUERIES": "<string>",
"DELTA_MAX_PENDING_CHANGES": "<string>",
"IMPORT_FOLDER": "<string>"
},
"sentinel": {
"enabled": true,
"replicas": 2,
"componentDefinition": "<string>",
"resources": {
"limits": {
"cpu": "<string>",
"memory": "<string>"
},
"requests": {
"cpu": "<string>",
"memory": "<string>"
}
},
"persistence": {
"enabled": true,
"storageClass": "<string>",
"size": "<string>",
"accessMode": "<string>"
},
"services": [
{
"name": "<string>",
"serviceType": "ClusterIP",
"annotations": {},
"podService": true
}
],
"schedulingPolicy": {
"nodeSelector": {},
"tolerations": [
{
"key": "<string>",
"operator": "Equal",
"value": "<string>",
"effect": "NoSchedule",
"tolerationSeconds": 1
}
]
}
},
"sharding": {
"enabled": true,
"shardCount": 4,
"replicas": 3,
"resources": {
"limits": {
"cpu": "<string>",
"memory": "<string>"
},
"requests": {
"cpu": "<string>",
"memory": "<string>"
}
},
"persistence": {
"enabled": true,
"storageClass": "<string>",
"size": "<string>",
"accessMode": "<string>"
},
"services": [
{
"name": "<string>",
"serviceType": "ClusterIP",
"annotations": {},
"podService": true
}
],
"schedulingPolicy": {
"nodeSelector": {},
"tolerations": [
{
"key": "<string>",
"operator": "Equal",
"value": "<string>",
"effect": "NoSchedule",
"tolerationSeconds": 1
}
]
}
},
"externalDomain": "<string>",
"labels": {},
"annotations": {},
"status": {
"state": "<string>",
"ready": true,
"replicas": 123,
"readyReplicas": 123,
"conditions": [
{
"type": "<string>",
"status": "<string>",
"reason": "<string>",
"message": "<string>",
"lastTransitionTime": "<string>"
}
]
}
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}Authorizations
JWT token stored in HTTP-only cookie
Path Parameters
Query Parameters
Body
application/json
Name for the new cluster to be created
Name of the backup to restore from. Required without restoreTime, and then it must be a full backup. With restoreTime it may be left out, and the continuous backup whose window holds that time is used; if given, it must name that continuous backup.
Namespace of the backup (defaults to cluster namespace). With restoreTime it must be the cluster's own namespace.
KubeBlocks volume restore policy (default: Parallel)
Available options:
Parallel Restore to this point in time (UTC, ISO 8601 to the second, e.g. 2026-11-02T14:30:00Z) from a continuous (AOF) backup. Must lie inside the restorable window reported by GET /restores/window. Writes after the window's latest time, which trails the present by a few seconds, are not restored.
Pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$Response
Default Response
state
Option 1 · enum<string>Option 2 · enum<string>Option 3 · enum<string>Option 4 · enum<string>Option 5 · enum<string>Option 6 · enum<string>Option 7 · enum<string>Option 8 · enum<string>
required
Available options:
Pending Available options:
standalone Available options:
DoNotTerminate Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
FalkorDB configuration key-value map that will be encoded into the FALKORDB_ARGS environment variable.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
DNS domain under which per-pod records are published, e.g. 'db.internal.example.com'. Requires routable pod IPs and an ExternalDNS instance.
Required string length:
1 - 253Pattern:
^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?