Get a specific cluster
curl --request GET \
--url http://localhost:3000/api/clusters/{clusterName} \
--cookie token=import requests
url = "http://localhost:3000/api/clusters/{clusterName}"
headers = {"cookie": "token="}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {cookie: 'token='}};
fetch('http://localhost:3000/api/clusters/{clusterName}', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/api/clusters/{clusterName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_COOKIE => "token=",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/clusters/{clusterName}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("cookie", "token=")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/clusters/{clusterName}")
.header("cookie", "token=")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/clusters/{clusterName}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["cookie"] = 'token='
response = http.request(request)
puts response.read_body{
"name": "<string>",
"namespace": "<string>",
"state": "Pending",
"replicas": 123,
"version": "<string>",
"creationTimestamp": "<string>",
"topology": "standalone",
"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
}
],
"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
}
]
},
"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
}
]
},
"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>"
}Clusters
Get a specific cluster
GET
/
api
/
clusters
/
{clusterName}
Get a specific cluster
curl --request GET \
--url http://localhost:3000/api/clusters/{clusterName} \
--cookie token=import requests
url = "http://localhost:3000/api/clusters/{clusterName}"
headers = {"cookie": "token="}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {cookie: 'token='}};
fetch('http://localhost:3000/api/clusters/{clusterName}', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/api/clusters/{clusterName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_COOKIE => "token=",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/clusters/{clusterName}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("cookie", "token=")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/clusters/{clusterName}")
.header("cookie", "token=")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/clusters/{clusterName}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["cookie"] = 'token='
response = http.request(request)
puts response.read_body{
"name": "<string>",
"namespace": "<string>",
"state": "Pending",
"replicas": 123,
"version": "<string>",
"creationTimestamp": "<string>",
"topology": "standalone",
"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
}
],
"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
}
]
},
"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
}
]
},
"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>"
}Authorizations
JWT token stored in HTTP-only cookie
Path Parameters
Query Parameters
namespace is required
Minimum string length:
1Response
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 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
⌘I