Skip to main content
POST
Clone a cluster from a full backup by creating a new cluster with the restore annotation

Authorizations

token
string
cookie
required

JWT token stored in HTTP-only cookie

Path Parameters

clusterName
string
required

Query Parameters

namespace
string
required

Body

application/json
newClusterName
string
required

Name for the new cluster to be created

backupName
string
required

Name of the full backup to restore from

backupNamespace
string

Namespace of the backup (defaults to cluster namespace)

volumeRestorePolicy

KubeBlocks volume restore policy (default: Parallel)

Available options:
Parallel

Response

Default Response

name
string
required
namespace
string
required
state
required
Available options:
Pending
replicas
number
required
version
string
required
creationTimestamp
string
topology
Available options:
standalone
componentDefinition
string
resources
object
persistence
object
services
object[]
modules
object
falkordbArgs
object

FalkorDB configuration key-value map that will be encoded into the FALKORDB_ARGS environment variable.

sentinel
object
sharding
object
externalDomain
string

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 - 253
Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
labels
object
annotations
object
status
object