Update an existing cluster

curl --request PATCH \
  --url http://localhost:3001/api/clusters/{clusterName} \
  --header 'Content-Type: application/json' \
  --cookie token= \
  --data '
{
  "schemaVersion": 1,
  "metadata": {},
  "spec": {}
}
'

import requests

url = "http://localhost:3001/api/clusters/{clusterName}"

payload = {
    "schemaVersion": 1,
    "metadata": {},
    "spec": {}
}
headers = {
    "cookie": "token=",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {cookie: 'token=', 'Content-Type': 'application/json'},
  body: JSON.stringify({schemaVersion: 1, metadata: {}, spec: {}})
};

fetch('http://localhost:3001/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 => "3001",
  CURLOPT_URL => "http://localhost:3001/api/clusters/{clusterName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'schemaVersion' => 1,
    'metadata' => [
        
    ],
    'spec' => [
        
    ]
  ]),
  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}"

	payload := strings.NewReader("{\n  \"schemaVersion\": 1,\n  \"metadata\": {},\n  \"spec\": {}\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("http://localhost:3001/api/clusters/{clusterName}")
  .header("cookie", "token=")
  .header("Content-Type", "application/json")
  .body("{\n  \"schemaVersion\": 1,\n  \"metadata\": {},\n  \"spec\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/clusters/{clusterName}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["cookie"] = 'token='
request["Content-Type"] = 'application/json'
request.body = "{\n  \"schemaVersion\": 1,\n  \"metadata\": {},\n  \"spec\": {}\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>"
      }
    ]
  }
}

{
  "schemaVersion": 1,
  "plan": {
    "changedPaths": [
      "<string>"
    ],
    "volumeExpansions": [
      {
        "componentName": "<string>",
        "storage": "<string>"
      }
    ],
    "reconfigure": [
      "<string>"
    ]
  },
  "deployment": {
    "schemaVersion": 1,
    "metadata": {
      "name": "<string>",
      "namespace": "<string>",
      "labels": {},
      "annotations": {},
      "creationTimestamp": "<string>",
      "generation": 123
    },
    "spec": {
      "topology": {
        "mode": "standalone",
        "replicas": 2,
        "shards": 4,
        "replicasPerShard": 3
      },
      "version": "<string>",
      "componentDefinition": "<string>",
      "nodes": {
        "resources": {
          "requests": {
            "cpu": "<string>",
            "memory": "<string>"
          },
          "limits": {
            "cpu": "<string>",
            "memory": "<string>"
          }
        },
        "storage": {
          "size": "<string>",
          "storageClass": "<string>"
        },
        "scheduling": {
          "nodeSelector": {},
          "tolerations": [
            {
              "key": "<string>",
              "operator": "Equal",
              "value": "<string>",
              "effect": "NoSchedule",
              "tolerationSeconds": 1
            }
          ]
        }
      },
      "sentinels": {
        "replicas": 2,
        "resources": {
          "requests": {
            "cpu": "<string>",
            "memory": "<string>"
          },
          "limits": {
            "cpu": "<string>",
            "memory": "<string>"
          }
        },
        "storage": {
          "size": "<string>",
          "storageClass": "<string>"
        },
        "scheduling": {
          "nodeSelector": {},
          "tolerations": [
            {
              "key": "<string>",
              "operator": "Equal",
              "value": "<string>",
              "effect": "NoSchedule",
              "tolerationSeconds": 1
            }
          ]
        }
      },
      "config": {
        "graph": {
          "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>"
        },
        "enterprise": {
          "falkordbe.idle-threshold-ms": "<string>",
          "falkordbe.evict-interval-ms": "<string>",
          "falkordbe.memory-pressure": "<string>",
          "falkordbe.load-evict-budget": "<string>",
          "falkordbe.ldap_servers": "<string>",
          "falkordbe.ldap_auth_mode": "<string>",
          "falkordbe.ldap_bind_dn_prefix": "<string>",
          "falkordbe.ldap_bind_dn_suffix": "<string>",
          "falkordbe.ldap_search_base": "<string>",
          "falkordbe.ldap_search_filter": "<string>",
          "falkordbe.ldap_search_scope": "<string>",
          "falkordbe.ldap_search_attribute": "<string>",
          "falkordbe.ldap_search_dn_attribute": "<string>",
          "falkordbe.ldap_search_bind_dn": "<string>",
          "falkordbe.ldap_search_bind_passwd": "<string>",
          "falkordbe.ldap_connection_pool_size": "<string>",
          "falkordbe.ldap_timeout_connection": "<string>",
          "falkordbe.ldap_timeout_ldap_operation": "<string>",
          "falkordbe.ldap_failure_detector_interval": "<string>",
          "falkordbe.ldap_use_starttls": "<string>",
          "falkordbe.ldap_tls_ca_cert_path": "<string>",
          "falkordbe.ldap_tls_cert_path": "<string>",
          "falkordbe.ldap_tls_key_path": "<string>",
          "falkordbe.ldap_tls_skip_verify": "<string>",
          "falkordbe.ldap_exempted_users_regex": "<string>",
          "falkordbe.ldap_return_auth_errors": "<string>",
          "falkordbe.ldap_acl_fallback_enabled": "<string>",
          "falkordbe.ldap_default_acl_rules": "<string>",
          "falkordbe.ldap_groups_search_base": "<string>",
          "falkordbe.ldap_groups_filter": "<string>",
          "falkordbe.ldap_groups_name_attribute": "<string>",
          "falkordbe.ldap_groups_member_attribute": "<string>",
          "falkordbe.ldap_groups_rules_attribute": "<string>",
          "falkordbe.ldap_group_acl_rules_map": "<string>",
          "falkordbe.ldap_group_acl_user_map": "<string>"
        },
        "server": {}
      },
      "networking": {
        "externalDomain": "<string>",
        "services": [
          {
            "name": "<string>",
            "target": "nodes",
            "type": "ClusterIP",
            "perPod": true,
            "annotations": {}
          }
        ]
      },
      "security": {
        "tls": {
          "issuer": "Enterprise",
          "secretRef": {
            "name": "<string>",
            "namespace": "<string>",
            "ca": "<string>",
            "cert": "<string>",
            "key": "<string>"
          },
          "issuerRef": {
            "name": "<string>",
            "kind": "Issuer"
          }
        },
        "auth": {
          "password": "<string>",
          "passwordSecretRef": {
            "name": "<string>",
            "key": "<string>"
          }
        }
      },
      "backup": {
        "schedule": "<string>",
        "retentionPeriod": "<string>"
      },
      "observability": {
        "exporter": true
      },
      "lifecycle": {
        "state": "Running",
        "deletionPolicy": "DoNotTerminate"
      }
    },
    "status": {
      "phase": "<string>",
      "state": "Pending",
      "ready": true,
      "managed": true,
      "unmanagedFields": [
        "<string>"
      ],
      "nodes": {
        "desired": 1,
        "ready": 1
      },
      "sentinels": {
        "desired": 1,
        "ready": 1
      },
      "tls": {
        "issuer": "Enterprise",
        "appliedFingerprint": "<string>",
        "certificateExpiresAt": "2023-11-07T05:31:56Z",
        "upToDate": true
      },
      "pendingChanges": [
        {
          "path": "<string>",
          "via": "OpsRequest",
          "name": "<string>",
          "type": "<string>",
          "phase": "<string>",
          "keys": [
            "<string>"
          ],
          "since": "<string>"
        }
      ],
      "conditions": [
        {
          "type": "<string>",
          "status": "<string>",
          "reason": "<string>",
          "message": "<string>",
          "lastTransitionTime": "<string>"
        }
      ],
      "observedGeneration": 123,
      "endpoints": {
        "internal": "<string>",
        "external": "<string>"
      }
    }
  },
  "dryRun": true
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "statusCode": 123,
  "message": "<string>"
}

{
  "error": "<string>",
  "statusCode": 123,
  "message": "<string>"
}

{
  "error": "<string>",
  "statusCode": 123,
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "statusCode": 123,
  "message": "<string>"
}

Clusters

Update an existing cluster

Update an existing cluster. A body with schemaVersion: 1 is a JSON Merge Patch on the deployment body GET ?schemaVersion=1 returns, and is answered with the updated deployment and the plan; a body without it is the legacy update request. Deprecated: The legacy update request: PATCH a JSON Merge Patch with schemaVersion: 1, or PUT a whole schemaVersion 1 deployment body. See https://docs.falkordb.com/enterprise/api-reference/deployments#deprecated-requests

PATCH

api

clusters

{clusterName}

Update an existing cluster

curl --request PATCH \
  --url http://localhost:3001/api/clusters/{clusterName} \
  --header 'Content-Type: application/json' \
  --cookie token= \
  --data '
{
  "schemaVersion": 1,
  "metadata": {},
  "spec": {}
}
'

import requests

url = "http://localhost:3001/api/clusters/{clusterName}"

payload = {
    "schemaVersion": 1,
    "metadata": {},
    "spec": {}
}
headers = {
    "cookie": "token=",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {cookie: 'token=', 'Content-Type': 'application/json'},
  body: JSON.stringify({schemaVersion: 1, metadata: {}, spec: {}})
};

fetch('http://localhost:3001/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 => "3001",
  CURLOPT_URL => "http://localhost:3001/api/clusters/{clusterName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'schemaVersion' => 1,
    'metadata' => [
        
    ],
    'spec' => [
        
    ]
  ]),
  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}"

	payload := strings.NewReader("{\n  \"schemaVersion\": 1,\n  \"metadata\": {},\n  \"spec\": {}\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("http://localhost:3001/api/clusters/{clusterName}")
  .header("cookie", "token=")
  .header("Content-Type", "application/json")
  .body("{\n  \"schemaVersion\": 1,\n  \"metadata\": {},\n  \"spec\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/clusters/{clusterName}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["cookie"] = 'token='
request["Content-Type"] = 'application/json'
request.body = "{\n  \"schemaVersion\": 1,\n  \"metadata\": {},\n  \"spec\": {}\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>"
      }
    ]
  }
}

{
  "schemaVersion": 1,
  "plan": {
    "changedPaths": [
      "<string>"
    ],
    "volumeExpansions": [
      {
        "componentName": "<string>",
        "storage": "<string>"
      }
    ],
    "reconfigure": [
      "<string>"
    ]
  },
  "deployment": {
    "schemaVersion": 1,
    "metadata": {
      "name": "<string>",
      "namespace": "<string>",
      "labels": {},
      "annotations": {},
      "creationTimestamp": "<string>",
      "generation": 123
    },
    "spec": {
      "topology": {
        "mode": "standalone",
        "replicas": 2,
        "shards": 4,
        "replicasPerShard": 3
      },
      "version": "<string>",
      "componentDefinition": "<string>",
      "nodes": {
        "resources": {
          "requests": {
            "cpu": "<string>",
            "memory": "<string>"
          },
          "limits": {
            "cpu": "<string>",
            "memory": "<string>"
          }
        },
        "storage": {
          "size": "<string>",
          "storageClass": "<string>"
        },
        "scheduling": {
          "nodeSelector": {},
          "tolerations": [
            {
              "key": "<string>",
              "operator": "Equal",
              "value": "<string>",
              "effect": "NoSchedule",
              "tolerationSeconds": 1
            }
          ]
        }
      },
      "sentinels": {
        "replicas": 2,
        "resources": {
          "requests": {
            "cpu": "<string>",
            "memory": "<string>"
          },
          "limits": {
            "cpu": "<string>",
            "memory": "<string>"
          }
        },
        "storage": {
          "size": "<string>",
          "storageClass": "<string>"
        },
        "scheduling": {
          "nodeSelector": {},
          "tolerations": [
            {
              "key": "<string>",
              "operator": "Equal",
              "value": "<string>",
              "effect": "NoSchedule",
              "tolerationSeconds": 1
            }
          ]
        }
      },
      "config": {
        "graph": {
          "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>"
        },
        "enterprise": {
          "falkordbe.idle-threshold-ms": "<string>",
          "falkordbe.evict-interval-ms": "<string>",
          "falkordbe.memory-pressure": "<string>",
          "falkordbe.load-evict-budget": "<string>",
          "falkordbe.ldap_servers": "<string>",
          "falkordbe.ldap_auth_mode": "<string>",
          "falkordbe.ldap_bind_dn_prefix": "<string>",
          "falkordbe.ldap_bind_dn_suffix": "<string>",
          "falkordbe.ldap_search_base": "<string>",
          "falkordbe.ldap_search_filter": "<string>",
          "falkordbe.ldap_search_scope": "<string>",
          "falkordbe.ldap_search_attribute": "<string>",
          "falkordbe.ldap_search_dn_attribute": "<string>",
          "falkordbe.ldap_search_bind_dn": "<string>",
          "falkordbe.ldap_search_bind_passwd": "<string>",
          "falkordbe.ldap_connection_pool_size": "<string>",
          "falkordbe.ldap_timeout_connection": "<string>",
          "falkordbe.ldap_timeout_ldap_operation": "<string>",
          "falkordbe.ldap_failure_detector_interval": "<string>",
          "falkordbe.ldap_use_starttls": "<string>",
          "falkordbe.ldap_tls_ca_cert_path": "<string>",
          "falkordbe.ldap_tls_cert_path": "<string>",
          "falkordbe.ldap_tls_key_path": "<string>",
          "falkordbe.ldap_tls_skip_verify": "<string>",
          "falkordbe.ldap_exempted_users_regex": "<string>",
          "falkordbe.ldap_return_auth_errors": "<string>",
          "falkordbe.ldap_acl_fallback_enabled": "<string>",
          "falkordbe.ldap_default_acl_rules": "<string>",
          "falkordbe.ldap_groups_search_base": "<string>",
          "falkordbe.ldap_groups_filter": "<string>",
          "falkordbe.ldap_groups_name_attribute": "<string>",
          "falkordbe.ldap_groups_member_attribute": "<string>",
          "falkordbe.ldap_groups_rules_attribute": "<string>",
          "falkordbe.ldap_group_acl_rules_map": "<string>",
          "falkordbe.ldap_group_acl_user_map": "<string>"
        },
        "server": {}
      },
      "networking": {
        "externalDomain": "<string>",
        "services": [
          {
            "name": "<string>",
            "target": "nodes",
            "type": "ClusterIP",
            "perPod": true,
            "annotations": {}
          }
        ]
      },
      "security": {
        "tls": {
          "issuer": "Enterprise",
          "secretRef": {
            "name": "<string>",
            "namespace": "<string>",
            "ca": "<string>",
            "cert": "<string>",
            "key": "<string>"
          },
          "issuerRef": {
            "name": "<string>",
            "kind": "Issuer"
          }
        },
        "auth": {
          "password": "<string>",
          "passwordSecretRef": {
            "name": "<string>",
            "key": "<string>"
          }
        }
      },
      "backup": {
        "schedule": "<string>",
        "retentionPeriod": "<string>"
      },
      "observability": {
        "exporter": true
      },
      "lifecycle": {
        "state": "Running",
        "deletionPolicy": "DoNotTerminate"
      }
    },
    "status": {
      "phase": "<string>",
      "state": "Pending",
      "ready": true,
      "managed": true,
      "unmanagedFields": [
        "<string>"
      ],
      "nodes": {
        "desired": 1,
        "ready": 1
      },
      "sentinels": {
        "desired": 1,
        "ready": 1
      },
      "tls": {
        "issuer": "Enterprise",
        "appliedFingerprint": "<string>",
        "certificateExpiresAt": "2023-11-07T05:31:56Z",
        "upToDate": true
      },
      "pendingChanges": [
        {
          "path": "<string>",
          "via": "OpsRequest",
          "name": "<string>",
          "type": "<string>",
          "phase": "<string>",
          "keys": [
            "<string>"
          ],
          "since": "<string>"
        }
      ],
      "conditions": [
        {
          "type": "<string>",
          "status": "<string>",
          "reason": "<string>",
          "message": "<string>",
          "lastTransitionTime": "<string>"
        }
      ],
      "observedGeneration": 123,
      "endpoints": {
        "internal": "<string>",
        "external": "<string>"
      }
    }
  },
  "dryRun": true
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "statusCode": 123,
  "message": "<string>"
}

{
  "error": "<string>",
  "statusCode": 123,
  "message": "<string>"
}

{
  "error": "<string>",
  "statusCode": 123,
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "statusCode": 123,
  "message": "<string>"
}

Authorizations

token

string

required

JWT token stored in HTTP-only cookie

Path Parameters

clusterName

string

required

Query Parameters

namespace

string

required

namespace is required

Minimum string length: 1

dryRun

boolean

Return the plan without applying it

overwriteUnmanaged

boolean

Replace fields set outside this API (YAML editor, kubectl) instead of refusing

Body

Option 1
Option 2

A JSON Merge Patch (RFC 7386) on a DeploymentV1Request: send only the fields to change, and null to remove one. Also accepted as application/merge-patch+json.

schemaVersion

enum<integer>

required

Available options:

1

metadata

object

Changes to DeploymentV1Request.metadata (labels and annotations).

spec

object

Changes to DeploymentV1Request.spec.

Response

Default Response

Option 1
Option 2

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

tls

boolean

terminationPolicy

Available options:

DoNotTerminate

resources

object

Show child attributes

persistence

object

Show child attributes

services

object[]

Show child attributes

modules

object

Show child attributes

falkordbArgs

object

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

Show child attributes

sentinel

object

Show child attributes

sharding

object

Show child attributes

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

Show child attributes

annotations

object

Show child attributes

status

object

Show child attributes

Overview

Admin Server API

Update an existing cluster

Authorizations

Path Parameters

Query Parameters

Body

Response