Skip to main content
POST
Create a new FalkorDB cluster from a raw YAML manifest

Authorizations

token
string
cookie
required

JWT token stored in HTTP-only cookie

Body

application/json
yaml
string
required

YAML representation of the cluster resource to apply

Minimum string length: 1

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