Estimated cost of every deployment the caller can see, plus fleet totals
Estimated cost of every deployment the caller can see, plus fleet totals. Costs are modelled from reserved capacity and operator-supplied prices, never read from a bill.
GET
/
api
/
clusters
/
costs
Estimated cost of every deployment the caller can see, plus fleet totals
curl --request GET \
--url http://localhost:3001/api/clusters/costs \
--cookie token=
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FalkorDB Docs","description":"Official FalkorDB documentation — the high-performance graph database for GraphRAG, Cypher queries, and knowledge graphs powering accurate GenAI applications.","colors":{"primary":"#FF8101","light":"#FDE900","dark":"#FF8101"},"logo":{"light":"https://mintcdn.com/falkordb-core/UsHkXui7FITcReVh/images/falkordb-logo-color.svg?fit=max\u0026auto=format\u0026n=UsHkXui7FITcReVh\u0026q=85\u0026s=d6cd14615384aaf1873f14dcebd7da7f","dark":"https://mintcdn.com/falkordb-core/4RKo-4HTPunDsB0h/images/falkordb-logo.svg?fit=max\u0026auto=format\u0026n=4RKo-4HTPunDsB0h\u0026q=85\u0026s=9fd7d3e195a0bf8907a119804e3f0694","href":"https://www.falkordb.com"},"favicon":"https://mintcdn.com/falkordb-core/4RKo-4HTPunDsB0h/images/favicon.ico?fit=max\u0026auto=format\u0026n=4RKo-4HTPunDsB0h\u0026q=85\u0026s=01ae535e76349bd2047c3da2475b1356","appearance":{"default":"dark"},"navbar":{"links":[{"href":"https://github.com/FalkorDB/FalkorDB","label":"Github"},{"href":"https://support.falkordb.com","label":"Support"},{"href":"https://discord.com/invite/6M4QwDXn2w","label":"Discord"}],"primary":{"type":"button","label":"Try FalkorDB Cloud","href":"https://app.falkordb.cloud"}},"footer":{"socials":{"github":"https://github.com/FalkorDB/FalkorDB","x":"https://x.com/FalkorDB","linkedin":"https://www.linkedin.com/company/falkordb","discord":"https://discord.com/invite/6M4QwDXn2w","youtube":"https://www.youtube.com/@falkordb","reddit":"https://www.reddit.com/r/falkordb"}},"seo":{"metatags":{"og:image":"https://docs.falkordb.com/images/falkor-logo.png","og:image:alt":"FalkorDB — the high-performance graph database for GraphRAG and GenAI","og:locale":"en_US","twitter:image":"https://docs.falkordb.com/images/falkor-logo.png","twitter:image:alt":"FalkorDB — the high-performance graph database for GraphRAG and GenAI","twitter:card":"summary_large_image","twitter:site":"@FalkorDB","twitter:creator":"@FalkorDB","author":"FalkorDB","publisher":"FalkorDB","application-name":"FalkorDB Docs","robots":"index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1","googlebot":"index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1","keywords":"FalkorDB, graph database, GraphRAG, knowledge graph, Cypher, OpenCypher, vector search, GenAI, RAG, RedisGraph, RedisGraph alternative, RedisGraph successor, RedisGraph migration, RedisGraph end of life, sparse matrix, linear algebra"},"organization":{"id":"https://www.falkordb.com/#organization","name":"FalkorDB","legalName":"FalkorDB Inc.","url":"https://www.falkordb.com","logo":"https://docs.falkordb.com/images/falkor-logo.png","sameAs":["https://github.com/FalkorDB/FalkorDB","https://x.com/FalkorDB","https://www.linkedin.com/company/falkordb","https://discord.com/invite/6M4QwDXn2w","https://www.youtube.com/@falkordb","https://www.reddit.com/r/falkordb/"]}},"integrations":{"gtm":{"tagId":"GTM-MBWB627H"}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","perplexity","mcp","add-mcp","cursor","vscode","download-spec"],"display":"header"},"markdown":{"instructions":["FalkorDB is a graph database that speaks the Redis protocol. Queries are issued as OpenCypher through the GRAPH.QUERY and GRAPH.RO_QUERY commands, not over Bolt or a SQL connection.","FalkorDB implements a subset of OpenCypher with proprietary extensions. Do not assume Neo4j-only syntax or procedures are available — check /cypher/cypher-support and /cypher/known-limitations before using a clause.","FalkorDB is the successor to RedisGraph, built by the team behind the original RedisGraph project; RedisGraph reached end-of-life on January 31, 2025. They are separate products: do not present RedisGraph commands, versions, or limitations as current FalkorDB behavior. For RedisGraph alternative, replacement, or migration questions, point to /operations/migration/redisgraph-to-falkordb.","Use the official clients listed in /getting-started/clients rather than generic Redis or Neo4j drivers, and prefer the language the user is already working in.","Configuration parameters are set with GRAPH.CONFIG SET or at startup; cite the exact parameter name from /getting-started/configuration rather than inventing one.","This site covers four products: FalkorDB (core), FalkorDB Cloud, FalkorDB Enterprise, and the GraphRAG SDK. Name which one an answer applies to, since setup and operations differ."]},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"falkordb-core","hasAudioNarration":false,"actualSubdomain":"falkordb-core","customDomains":["docs.falkordb.com"],"gitSource":{"type":"github","owner":"falkordb","repo":"docs","deployBranch":"docs-site","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ada076d79900545ca232661","collectionId":"29b1c9b2-358b-4723-adb9-ab63f134da97","liveDeploymentHistoryId":"6ada076d79900545ca232661","schemaVersion":"v3"},"feedback":{"edits":true,"issues":true,"thumbs":true},"entitlements":{},"buildId":"6adc31e7d1707600bd3e0b9f","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"FalkorDB Cloud","count":227},{"language":"default","tag":"API Reference","count":209},{"language":"default","tag":"Documentation","count":190},{"language":"default","tag":"FalkorDB Enterprise","count":181},{"language":"default","tag":"FalkorDB","count":170},{"language":"default","tag":"API reference","count":125},{"language":"default","tag":"Admin Server API","count":122},{"language":"default","tag":"Enterprise BYOA","count":55},{"language":"default","tag":"Enterprise","count":55},{"language":"default","tag":"Browser","count":44}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#sidebar-content .sidebar-group{margin-top:.5rem}#sidebar-content .sidebar-group:first-child{margin-top:0}"}],"page":{"pagePath":"enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals","slug":"/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals","pageMetadata":{"title":"Estimated cost of every deployment the caller can see, plus fleet totals","description":"Estimated cost of every deployment the caller can see, plus fleet totals. Costs are modelled from reserved capacity and operator-supplied prices, never read from a bill.","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/costs","href":"/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Estimated cost of every deployment the caller can see, plus fleet totals. Costs are modelled from reserved capacity and operator-supplied prices, never read from a bill.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Estimated cost of every deployment the caller can see, plus fleet totals","description":"Estimated cost of every deployment the caller can see, plus fleet totals. Costs are modelled from reserved capacity and operator-supplied prices, never read from a bill.","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/costs","href":"/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Clusters"],"description":"Estimated cost of every deployment the caller can see, plus fleet totals. Costs are modelled from reserved capacity and operator-supplied prices, never read from a bill.","security":["9bda716a-3e6e-4586-bcb6-184655fa7334"],"responses":{"200":"c463ac18-e836-486d-a44f-e0ed31a99dd7","403":"c144c67c-cfad-4d64-9e0e-79fe462f61e9","500":"9df43699-092b-43df-80d9-e334b734ff49"},"summary":"Estimated cost of every deployment the caller can see, plus fleet totals","method":"get","type":"path","servers":["697937b1-3940-4556-a311-df4946614345"],"path":"/api/clusters/costs","baseUrlOptions":["http://localhost:3001"],"title":"Estimated cost of every deployment the caller can see, plus fleet totals","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"c463ac18-e836-486d-a44f-e0ed31a99dd7":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["generatedAt","provider","configured","estimated","totals","databases"],"properties":{"generatedAt":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"generatedAt","typeLabel":"string\u003cdate-time>"},"provider":{"oneOf":[{"type":"string","enum":["rate-card"],"isRequired":true,"uniqueKey":"provider.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["opencost"],"isRequired":true,"uniqueKey":"provider.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["none"],"isRequired":true,"uniqueKey":"provider.oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"configured":{"description":"False when no pricing is configured; costs are omitted and only footprints reported","type":"boolean","isRequired":true,"uniqueKey":"configured","typeLabel":"boolean"},"estimated":{"description":"Always true. Costs are modelled from reserved capacity and operator-supplied prices, never read from a bill.","type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"estimated","typeLabel":"enum\u003cboolean>"},"totals":{"type":"object","required":["cpuCores","memoryGb","storageGb","components"],"properties":{"cpuCores":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"totals.cpuCores","typeLabel":"number"},"memoryGb":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"totals.memoryGb","typeLabel":"number"},"storageGb":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"totals.storageGb","typeLabel":"number"},"components":{"type":"array","items":{"type":"object","required":["component","replicas","cpuCores","memoryGb","storageGb"],"properties":{"component":{"description":"Component name, e.g. 'falkordb', 'sentinel', 'sharding'","type":"string","isRequired":true,"uniqueKey":"totals.components.items.[INDEX].component","typeLabel":"string"},"replicas":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"totals.components.items.[INDEX].replicas","typeLabel":"number"},"cpuCores":{"minimum":0,"description":"Reserved CPU cores across all replicas","type":"number","isRequired":true,"uniqueKey":"totals.components.items.[INDEX].cpuCores","typeLabel":"number"},"memoryGb":{"minimum":0,"description":"Reserved memory GB across all replicas","type":"number","isRequired":true,"uniqueKey":"totals.components.items.[INDEX].memoryGb","typeLabel":"number"},"storageGb":{"minimum":0,"description":"Provisioned storage GB across all replicas","type":"number","isRequired":true,"uniqueKey":"totals.components.items.[INDEX].storageGb","typeLabel":"number"},"storageClass":{"type":"string","uniqueKey":"totals.components.items.[INDEX].storageClass","typeLabel":"string"}},"uniqueKey":"totals.components.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"totals.components","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"totals","typeLabel":"object"},"databases":{"type":"array","items":{"type":"object","required":["name","namespace","footprint","shareOfTotal","warnings"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"databases.items.[INDEX].name","typeLabel":"string"},"namespace":{"type":"string","isRequired":true,"uniqueKey":"databases.items.[INDEX].namespace","typeLabel":"string"},"footprint":{"type":"object","required":["cpuCores","memoryGb","storageGb","components"],"properties":{"cpuCores":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].footprint.cpuCores","typeLabel":"number"},"memoryGb":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].footprint.memoryGb","typeLabel":"number"},"storageGb":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].footprint.storageGb","typeLabel":"number"},"components":{"type":"array","items":{"type":"object","required":["component","replicas","cpuCores","memoryGb","storageGb"],"properties":{"component":{"description":"Component name, e.g. 'falkordb', 'sentinel', 'sharding'","type":"string","isRequired":true,"uniqueKey":"databases.items.[INDEX].footprint.components.items.[INDEX].component","typeLabel":"string"},"replicas":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].footprint.components.items.[INDEX].replicas","typeLabel":"number"},"cpuCores":{"minimum":0,"description":"Reserved CPU cores across all replicas","type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].footprint.components.items.[INDEX].cpuCores","typeLabel":"number"},"memoryGb":{"minimum":0,"description":"Reserved memory GB across all replicas","type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].footprint.components.items.[INDEX].memoryGb","typeLabel":"number"},"storageGb":{"minimum":0,"description":"Provisioned storage GB across all replicas","type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].footprint.components.items.[INDEX].storageGb","typeLabel":"number"},"storageClass":{"type":"string","uniqueKey":"databases.items.[INDEX].footprint.components.items.[INDEX].storageClass","typeLabel":"string"}},"uniqueKey":"databases.items.[INDEX].footprint.components.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"databases.items.[INDEX].footprint.components","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"databases.items.[INDEX].footprint","typeLabel":"object"},"shareOfTotal":{"minimum":0,"maximum":1,"description":"Fraction of the fleet this database accounts for. Priced share when pricing is configured, otherwise share of reserved CPU cores.","type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].shareOfTotal","typeLabel":"number"},"warnings":{"type":"array","items":{"oneOf":[{"type":"string","enum":["no-cpu-request"],"uniqueKey":"databases.items.[INDEX].warnings.items.[INDEX].oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["no-memory-request"],"uniqueKey":"databases.items.[INDEX].warnings.items.[INDEX].oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"databases.items.[INDEX].warnings.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"databases.items.[INDEX].warnings","typeLabel":"enum\u003cstring>[]"},"topology":{"type":"string","uniqueKey":"databases.items.[INDEX].topology","typeLabel":"string"},"cost":{"type":"object","required":["cpu","memory","storage","total"],"properties":{"cpu":{"type":"object","required":["hourly","monthly"],"properties":{"hourly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].cost.cpu.hourly","typeLabel":"number"},"monthly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].cost.cpu.monthly","typeLabel":"number"}},"isRequired":true,"uniqueKey":"databases.items.[INDEX].cost.cpu","typeLabel":"object"},"memory":{"type":"object","required":["hourly","monthly"],"properties":{"hourly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].cost.memory.hourly","typeLabel":"number"},"monthly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].cost.memory.monthly","typeLabel":"number"}},"isRequired":true,"uniqueKey":"databases.items.[INDEX].cost.memory","typeLabel":"object"},"storage":{"type":"object","required":["hourly","monthly"],"properties":{"hourly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].cost.storage.hourly","typeLabel":"number"},"monthly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].cost.storage.monthly","typeLabel":"number"}},"isRequired":true,"uniqueKey":"databases.items.[INDEX].cost.storage","typeLabel":"object"},"total":{"type":"object","required":["hourly","monthly"],"properties":{"hourly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].cost.total.hourly","typeLabel":"number"},"monthly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"databases.items.[INDEX].cost.total.monthly","typeLabel":"number"}},"isRequired":true,"uniqueKey":"databases.items.[INDEX].cost.total","typeLabel":"object"}},"uniqueKey":"databases.items.[INDEX].cost","typeLabel":"object"}},"uniqueKey":"databases.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"databases","typeLabel":"object[]"},"currency":{"description":"ISO 4217 currency code","type":"string","uniqueKey":"currency","typeLabel":"string"},"cost":{"type":"object","required":["cpu","memory","storage","total"],"properties":{"cpu":{"type":"object","required":["hourly","monthly"],"properties":{"hourly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"cost.cpu.hourly","typeLabel":"number"},"monthly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"cost.cpu.monthly","typeLabel":"number"}},"isRequired":true,"uniqueKey":"cost.cpu","typeLabel":"object"},"memory":{"type":"object","required":["hourly","monthly"],"properties":{"hourly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"cost.memory.hourly","typeLabel":"number"},"monthly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"cost.memory.monthly","typeLabel":"number"}},"isRequired":true,"uniqueKey":"cost.memory","typeLabel":"object"},"storage":{"type":"object","required":["hourly","monthly"],"properties":{"hourly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"cost.storage.hourly","typeLabel":"number"},"monthly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"cost.storage.monthly","typeLabel":"number"}},"isRequired":true,"uniqueKey":"cost.storage","typeLabel":"object"},"total":{"type":"object","required":["hourly","monthly"],"properties":{"hourly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"cost.total.hourly","typeLabel":"number"},"monthly":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"cost.total.monthly","typeLabel":"number"}},"isRequired":true,"uniqueKey":"cost.total","typeLabel":"object"}},"uniqueKey":"cost","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"generatedAt":"2023-11-07T05:31:56Z","provider":"rate-card","configured":true,"estimated":true,"totals":{"cpuCores":1,"memoryGb":1,"storageGb":1,"components":[{"component":"\u003cstring>","replicas":1,"cpuCores":1,"memoryGb":1,"storageGb":1,"storageClass":"\u003cstring>"}]},"databases":[{"name":"\u003cstring>","namespace":"\u003cstring>","footprint":{"cpuCores":1,"memoryGb":1,"storageGb":1,"components":[{"component":"\u003cstring>","replicas":1,"cpuCores":1,"memoryGb":1,"storageGb":1,"storageClass":"\u003cstring>"}]},"shareOfTotal":0.5,"warnings":["no-cpu-request"],"topology":"\u003cstring>","cost":{"cpu":{"hourly":1,"monthly":1},"memory":{"hourly":1,"monthly":1},"storage":{"hourly":1,"monthly":1},"total":{"hourly":1,"monthly":1}}}],"currency":"\u003cstring>","cost":{"cpu":{"hourly":1,"monthly":1},"memory":{"hourly":1,"monthly":1},"storage":{"hourly":1,"monthly":1},"total":{"hourly":1,"monthly":1}}}}},"exampleType":"generated"}},"exampleType":"generated"},"c144c67c-cfad-4d64-9e0e-79fe462f61e9":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"statusCode":{"type":"number","uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","statusCode":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9df43699-092b-43df-80d9-e334b734ff49":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"statusCode":{"type":"number","uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","statusCode":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9bda716a-3e6e-4586-bcb6-184655fa7334":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"token","description":"JWT token stored in HTTP-only cookie","scopes":[],"schemeName":"cookieAuth"}}},"servers":{"697937b1-3940-4556-a311-df4946614345":{"url":"http://localhost:3001","description":"Development server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"cookie","name":"token","description":"JWT token stored in HTTP-only cookie","scopes":[],"schemeName":"cookieAuth"},"schema":{"title":"token","type":"string","description":"JWT token stored in HTTP-only cookie","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"cookieAuth","name":"token"}],"title":"cookieAuth"}]},"originalFileLocation":"enterprise/api-reference/admin-server.json"},"subdomain":"falkordb-core","siteName":"FalkorDB Docs","title":"Estimated cost of every deployment the caller can see, plus fleet totals - FalkorDB Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T06:12:47.989Z","originalFileLocation":"enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Estimated cost of every deployment the caller can see, plus fleet totals. Costs are modelled from reserved capacity and operator-supplied prices, never read from a bill.\">\u003cmeta data-mint-head name=\"keywords\" content=\"FalkorDB, graph database, GraphRAG, knowledge graph, Cypher, OpenCypher, vector search, GenAI, RAG, RedisGraph, RedisGraph alternative, RedisGraph successor, RedisGraph migration, RedisGraph end of life, sparse matrix, linear algebra\">\u003cmeta data-mint-head name=\"application-name\" content=\"FalkorDB Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/falkordb-core/mDs9ei6IUGTBvS7e/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/falkordb-core/mDs9ei6IUGTBvS7e/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/falkordb-core/mDs9ei6IUGTBvS7e/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/falkordb-core/mDs9ei6IUGTBvS7e/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/falkordb-core/mDs9ei6IUGTBvS7e/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/falkordb-core/mDs9ei6IUGTBvS7e/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/falkordb-core/mDs9ei6IUGTBvS7e/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/falkordb-core/mDs9ei6IUGTBvS7e/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/falkordb-core/mDs9ei6IUGTBvS7e/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Estimated cost of every deployment the caller can see, plus fleet totals - FalkorDB Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Estimated cost of every deployment the caller can see, plus fleet totals. Costs are modelled from reserved capacity and operator-supplied prices, never read from a bill.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FalkorDB Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.falkordb.com/images/falkor-logo.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Estimated cost of every deployment the caller can see, plus fleet totals - FalkorDB Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Estimated cost of every deployment the caller can see, plus fleet totals. Costs are modelled from reserved capacity and operator-supplied prices, never read from a bill.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.falkordb.com/images/falkor-logo.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/falkordb-core/mDs9ei6IUGTBvS7e/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FalkorDB Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF8101\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"FalkorDB — the high-performance graph database for GraphRAG and GenAI\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"FalkorDB — the high-performance graph database for GraphRAG and GenAI\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@FalkorDB\">\u003cmeta data-mint-head name=\"author\" content=\"FalkorDB\">\u003cmeta data-mint-head name=\"publisher\" content=\"FalkorDB\">\u003cmeta data-mint-head name=\"application-name\" content=\"FalkorDB Docs\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.falkordb.com/#organization\",\"name\":\"FalkorDB\",\"legalName\":\"FalkorDB Inc.\",\"url\":\"https://www.falkordb.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.falkordb.com/images/falkor-logo.png\"},\"sameAs\":[\"https://github.com/FalkorDB/FalkorDB\",\"https://x.com/FalkorDB\",\"https://www.linkedin.com/company/falkordb\",\"https://discord.com/invite/6M4QwDXn2w\",\"https://www.youtube.com/@falkordb\",\"https://www.reddit.com/r/falkordb/\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.falkordb.com#website\",\"name\":\"FalkorDB Docs\",\"url\":\"https://docs.falkordb.com\",\"publisher\":{\"@id\":\"https://www.falkordb.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals#webpage\",\"url\":\"https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals\",\"name\":\"Estimated cost of every deployment the caller can see, plus fleet totals\",\"description\":\"Estimated cost of every deployment the caller can see, plus fleet totals. Costs are modelled from reserved capacity and operator-supplied prices, never read from a bill.\",\"dateModified\":\"2026-10-22T06:12:47.989Z\",\"isPartOf\":{\"@id\":\"https://docs.falkordb.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Admin Server API\",\"item\":\"https://docs.falkordb.com/enterprise/api-reference/endpoints/system/liveness-probe-for-the-falkordb-enterprise-admin-server\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Clusters\",\"item\":\"https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/list-all-clusters\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Estimated cost of every deployment the caller can see, plus fleet totals\",\"item\":\"https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals#apireference\",\"headline\":\"Estimated cost of every deployment the caller can see, plus fleet totals\",\"name\":\"Estimated cost of every deployment the caller can see, plus fleet totals\",\"description\":\"Estimated cost of every deployment the caller can see, plus fleet totals. Costs are modelled from reserved capacity and operator-supplied prices, never read from a bill.\",\"url\":\"https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals\",\"mainEntityOfPage\":{\"@id\":\"https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals#webpage\"},\"image\":\"https://docs.falkordb.com/images/falkor-logo.png\",\"dateModified\":\"2026-10-22T06:12:47.989Z\",\"publisher\":{\"@id\":\"https://www.falkordb.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.falkordb.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FalkorDB Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"FalkorDB Docs","nav":{"global":null,"products":[{"product":"FalkorDB","icon":"database","description":"The open source graph database, Cypher language, and tooling.","pages":[{"title":"FalkorDB","href":""}]},{"product":"FalkorDB Cloud","icon":"cloud","description":"The managed FalkorDB service and its provisioning API.","pages":[{"title":"FalkorDB Cloud","href":"/cloud"}]},{"product":"FalkorDB Enterprise","icon":"building","description":"Self-managed FalkorDB on your own Kubernetes clusters.","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/enterprise"}]},{"tab":"Reference","pages":[{"title":"Reference","href":"/enterprise/reference/helm-values"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"FalkorDB Enterprise Admin Server REST API reference","sidebarTitle":"API overview","icon":"code","href":"/enterprise/api-reference/introduction"},{"title":"Deployment bodies","sidebarTitle":"Deployment bodies","icon":"file-code","href":"/enterprise/api-reference/deployments"},{"title":"KubeBlocks custom resources reference for FalkorDB Enterprise","sidebarTitle":"KubeBlocks resources","icon":"dharmachakra","href":"/enterprise/api-reference/kubeblocks"}]},{"group":"Admin Server API","pages":[{"group":"System","pages":[{"title":"Liveness probe for the FalkorDB Enterprise admin server","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /health","href":"/enterprise/api-reference/endpoints/system/liveness-probe-for-the-falkordb-enterprise-admin-server"},{"title":"Readiness probe for the FalkorDB Enterprise admin server","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /ready","href":"/enterprise/api-reference/endpoints/system/readiness-probe-for-the-falkordb-enterprise-admin-server"},{"title":"List all available Kubernetes namespaces","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/system/namespaces","href":"/enterprise/api-reference/endpoints/system/list-all-available-kubernetes-namespaces"},{"title":"List all available FalkorDB component versions","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/system/falkordb-versions","href":"/enterprise/api-reference/endpoints/system/list-all-available-falkordb-component-versions"},{"title":"List all available Kubernetes StorageClasses","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/system/storage-classes","href":"/enterprise/api-reference/endpoints/system/list-all-available-kubernetes-storageclasses"},{"title":"Get aggregated cluster CPU/memory/storage capacity and deployment vs support usage split","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/system/cluster-resources","href":"/enterprise/api-reference/endpoints/system/get-aggregated-cluster-cpumemorystorage-capacity-and-deployment-vs-support-usage-split"}]},{"group":"Authentication","pages":[{"title":"Get supported authentication methods and their public configuration","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/auth/config","href":"/enterprise/api-reference/endpoints/authentication/get-supported-authentication-methods-and-their-public-configuration"},{"title":"Authenticate user with email and password","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/auth/login","href":"/enterprise/api-reference/endpoints/authentication/authenticate-user-with-email-and-password"},{"title":"Logout current user","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/auth/logout","href":"/enterprise/api-reference/endpoints/authentication/logout-current-user"},{"title":"Validate authentication token","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/auth/validate","href":"/enterprise/api-reference/endpoints/authentication/validate-authentication-token"}]},{"group":"OAuth","pages":[{"title":"Initiate OAuth flow for a configured provider","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/auth/oauth/{provider}","href":"/enterprise/api-reference/endpoints/oauth/initiate-oauth-flow-for-a-configured-provider"},{"title":"Handle OAuth callback for a configured provider","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/auth/oauth/{provider}/callback","href":"/enterprise/api-reference/endpoints/oauth/handle-oauth-callback-for-a-configured-provider"},{"title":"Handle OAuth callback for the configured provider","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/auth/oauth/callback","href":"/enterprise/api-reference/endpoints/oauth/handle-oauth-callback-for-the-configured-provider"}]},{"group":"Users","pages":[{"title":"List all users with optional filtering","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/users/","href":"/enterprise/api-reference/endpoints/users/list-all-users-with-optional-filtering"},{"title":"Create a new user","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/users/","href":"/enterprise/api-reference/endpoints/users/create-a-new-user"},{"title":"Get a specific user by email","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/users/{email}","href":"/enterprise/api-reference/endpoints/users/get-a-specific-user-by-email"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json delete /api/users/{email}","href":"/enterprise/api-reference/endpoints/users/delete-a-user"},{"title":"Update an existing user","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json patch /api/users/{email}","href":"/enterprise/api-reference/endpoints/users/update-an-existing-user"},{"title":"Reset user password","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/users/{email}/reset-password","href":"/enterprise/api-reference/endpoints/users/reset-user-password"}]},{"group":"User Profile","pages":[{"title":"Get current user profile","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/users/me/","href":"/enterprise/api-reference/endpoints/user-profile/get-current-user-profile"},{"title":"Change current user password","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json patch /api/users/me/password","href":"/enterprise/api-reference/endpoints/user-profile/change-current-user-password"},{"title":"Get current user activity history","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/users/me/activity","href":"/enterprise/api-reference/endpoints/user-profile/get-current-user-activity-history"}]},{"group":"Backup Repositories","pages":[{"title":"List all backup repositories","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/backups/repositories/","href":"/enterprise/api-reference/endpoints/backup-repositories/list-all-backup-repositories"},{"title":"Create a new backup repository","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/backups/repositories/","href":"/enterprise/api-reference/endpoints/backup-repositories/create-a-new-backup-repository"},{"title":"Get a specific backup repository","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/backups/repositories/{name}","href":"/enterprise/api-reference/endpoints/backup-repositories/get-a-specific-backup-repository"},{"title":"Delete a backup repository","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json delete /api/backups/repositories/{name}","href":"/enterprise/api-reference/endpoints/backup-repositories/delete-a-backup-repository"},{"title":"Update an existing backup repository","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json patch /api/backups/repositories/{name}","href":"/enterprise/api-reference/endpoints/backup-repositories/update-an-existing-backup-repository"}]},{"group":"Settings","pages":[{"title":"Get all admin settings","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/settings/","href":"/enterprise/api-reference/endpoints/settings/get-all-admin-settings"},{"title":"Update admin settings","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json patch /api/settings/","href":"/enterprise/api-reference/endpoints/settings/update-admin-settings"}]},{"group":"Audit","pages":[{"title":"Query audit logs with filtering","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/audit/","href":"/enterprise/api-reference/endpoints/audit/query-audit-logs-with-filtering"}]},{"group":"RBAC","pages":[{"title":"Get current RBAC configuration","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/rbac/","href":"/enterprise/api-reference/endpoints/rbac/get-current-rbac-configuration"},{"title":"Update RBAC configuration (full replace)","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json put /api/rbac/","href":"/enterprise/api-reference/endpoints/rbac/update-rbac-configuration-full-replace"},{"title":"Reload RBAC configuration from ConfigMap","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/rbac/reload","href":"/enterprise/api-reference/endpoints/rbac/reload-rbac-configuration-from-configmap"},{"title":"List all RBAC roles","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/rbac/roles","href":"/enterprise/api-reference/endpoints/rbac/list-all-rbac-roles"},{"title":"Create a custom RBAC role","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/rbac/roles","href":"/enterprise/api-reference/endpoints/rbac/create-a-custom-rbac-role"},{"title":"Get specific RBAC role by name","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/rbac/roles/{roleName}","href":"/enterprise/api-reference/endpoints/rbac/get-specific-rbac-role-by-name"},{"title":"Update a custom RBAC role","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json put /api/rbac/roles/{roleName}","href":"/enterprise/api-reference/endpoints/rbac/update-a-custom-rbac-role"},{"title":"Delete a custom RBAC role","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json delete /api/rbac/roles/{roleName}","href":"/enterprise/api-reference/endpoints/rbac/delete-a-custom-rbac-role"},{"title":"List all group-to-role mappings","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/rbac/group-mappings","href":"/enterprise/api-reference/endpoints/rbac/list-all-group-to-role-mappings"},{"title":"Create a group-to-role mapping","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/rbac/group-mappings","href":"/enterprise/api-reference/endpoints/rbac/create-a-group-to-role-mapping"},{"title":"Update a group-to-role mapping","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json put /api/rbac/group-mappings/{groupEmail}","href":"/enterprise/api-reference/endpoints/rbac/update-a-group-to-role-mapping"},{"title":"Delete a group-to-role mapping","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json delete /api/rbac/group-mappings/{groupEmail}","href":"/enterprise/api-reference/endpoints/rbac/delete-a-group-to-role-mapping"}]},{"group":"Diagnostics","pages":[{"title":"Get comprehensive system diagnostics","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/admin/diagnostics/","href":"/enterprise/api-reference/endpoints/diagnostics/get-comprehensive-system-diagnostics"},{"title":"Export diagnostics data as downloadable JSON file","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/admin/diagnostics/export","href":"/enterprise/api-reference/endpoints/diagnostics/export-diagnostics-data-as-downloadable-json-file"},{"title":"Export a compact support diagnostics package for FalkorDB support","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/admin/diagnostics/support-package","href":"/enterprise/api-reference/endpoints/diagnostics/export-a-compact-support-diagnostics-package-for-falkordb-support"},{"title":"Check system health status","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/admin/diagnostics/health","href":"/enterprise/api-reference/endpoints/diagnostics/check-system-health-status"}]},{"group":"Licensing","pages":[{"title":"Get license status and current resource usage","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/admin/licensing/status","href":"/enterprise/api-reference/endpoints/licensing/get-license-status-and-current-resource-usage"},{"title":"Activate FalkorDB Enterprise with a signed license","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/admin/licensing/activate","href":"/enterprise/api-reference/endpoints/licensing/activate-falkordb-enterprise-with-a-signed-license"}]},{"group":"Metrics","pages":[{"title":"Get system-wide metrics including CPU, memory, and cluster stats","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/metrics/","href":"/enterprise/api-reference/endpoints/metrics/get-system-wide-metrics-including-cpu-memory-and-cluster-stats"}]},{"group":"Search","pages":[{"title":"Search across clusters, backups, and users","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/search/","href":"/enterprise/api-reference/endpoints/search/search-across-clusters-backups-and-users"}]},{"group":"Clusters","pages":[{"title":"List all clusters","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/","href":"/enterprise/api-reference/endpoints/clusters/list-all-clusters"},{"title":"Create a new FalkorDB cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/","href":"/enterprise/api-reference/endpoints/clusters/create-a-new-falkordb-cluster"},{"title":"Get a specific cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}","href":"/enterprise/api-reference/endpoints/clusters/get-a-specific-cluster"},{"title":"Replace a deployment's desired state with a whole `schemaVersion: 1` deployment body","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json put /api/clusters/{clusterName}","href":"/enterprise/api-reference/endpoints/clusters/replace-a-deployments-desired-state-with-a-whole-`schemaversion:-1`-deployment-body"},{"title":"Delete a cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json delete /api/clusters/{clusterName}","href":"/enterprise/api-reference/endpoints/clusters/delete-a-cluster"},{"title":"Update an existing cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json patch /api/clusters/{clusterName}","href":"/enterprise/api-reference/endpoints/clusters/update-an-existing-cluster"},{"title":"List the cert-manager Issuers in a namespace and the ClusterIssuers that can sign a deployment's TLS certificates, and whether cert-manager is installed","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/tls/cert-manager-issuers","href":"/enterprise/api-reference/endpoints/clusters/list-the-cert-manager-issuers-in-a-namespace-and-the-clusterissuers-that-can-sign-a-deployments-tls-certificates-and-whether-cert-manager-is-installed"},{"title":"Retrieve the JSON schema (openAPIV3Schema) for the Cluster custom resource definition","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/schema","href":"/enterprise/api-reference/endpoints/clusters/retrieve-the-json-schema-openapiv3schema-for-the-cluster-custom-resource-definition"},{"title":"Create a new FalkorDB cluster from a raw YAML manifest","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/yaml","href":"/enterprise/api-reference/endpoints/clusters/create-a-new-falkordb-cluster-from-a-raw-yaml-manifest"},{"title":"Get the raw YAML of a cluster custom resource","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/yaml","href":"/enterprise/api-reference/endpoints/clusters/get-the-raw-yaml-of-a-cluster-custom-resource"},{"title":"Replace a cluster custom resource from YAML","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/yaml","href":"/enterprise/api-reference/endpoints/clusters/replace-a-cluster-custom-resource-from-yaml"},{"title":"List all KubeBlocks OpsRequests for a cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/operations","href":"/enterprise/api-reference/endpoints/clusters/list-all-kubeblocks-opsrequests-for-a-cluster"},{"title":"Return audit log events for a cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/events","href":"/enterprise/api-reference/endpoints/clusters/return-audit-log-events-for-a-cluster"},{"title":"List all pods for a specific cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/pods","href":"/enterprise/api-reference/endpoints/clusters/list-all-pods-for-a-specific-cluster"},{"title":"Get logs from a specific pod","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{name}/pods/{podName}/logs","href":"/enterprise/api-reference/endpoints/clusters/get-logs-from-a-specific-pod"},{"title":"Stream logs from a specific pod using Server-Sent Events","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{name}/pods/{podName}/logs/stream","href":"/enterprise/api-reference/endpoints/clusters/stream-logs-from-a-specific-pod-using-server-sent-events"},{"title":"Get aggregated metrics for all pods in a cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{name}/metrics","href":"/enterprise/api-reference/endpoints/clusters/get-aggregated-metrics-for-all-pods-in-a-cluster"},{"title":"Get Prometheus metrics from a pod parsed into structured JSON","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{name}/pods/{podName}/metrics","href":"/enterprise/api-reference/endpoints/clusters/get-prometheus-metrics-from-a-pod-parsed-into-structured-json"},{"title":"Stream parsed Prometheus pod metrics as Server-Sent Events","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{name}/pods/{podName}/metrics/stream","href":"/enterprise/api-reference/endpoints/clusters/stream-parsed-prometheus-pod-metrics-as-server-sent-events"},{"title":"Stream aggregated cluster metrics (CPU \u0026 memory) as Server-Sent Events","description":"Stream aggregated cluster metrics (CPU \u0026 memory) as Server-Sent Events. Each event contains the same fields as GET /:name/metrics.","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{name}/metrics/stream","href":"/enterprise/api-reference/endpoints/clusters/stream-aggregated-cluster-metrics-cpu-\u0026-memory-as-server-sent-events"},{"title":"Estimated cost of every deployment the caller can see, plus fleet totals","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/costs","href":"/enterprise/api-reference/endpoints/clusters/estimated-cost-of-every-deployment-the-caller-can-see-plus-fleet-totals"},{"title":"Estimate the cost of a prospective deployment spec, for create and scale flows","description":"Estimate the cost of a prospective deployment spec, for create and scale flows. Reads no existing deployments.","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/costs/estimate","href":"/enterprise/api-reference/endpoints/clusters/estimate-the-cost-of-a-prospective-deployment-spec-for-create-and-scale-flows"},{"title":"Estimated cost of a single deployment and its share of total fleet spend","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/cost","href":"/enterprise/api-reference/endpoints/clusters/estimated-cost-of-a-single-deployment-and-its-share-of-total-fleet-spend"},{"title":"Upgrade a cluster FalkorDB version and/or addon ComponentDefinition","deprecated":true,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/upgrade","href":"/enterprise/api-reference/endpoints/clusters/upgrade-a-cluster-falkordb-version-andor-addon-componentdefinition"},{"title":"Get connection credentials (hostname, port, username, password) for a cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/credentials","href":"/enterprise/api-reference/endpoints/clusters/get-connection-credentials-hostname-port-username-password-for-a-cluster"},{"title":"Get Redis runtime configuration (redis.conf) for a cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/config","href":"/enterprise/api-reference/endpoints/clusters/get-redis-runtime-configuration-redisconf-for-a-cluster"}]},{"group":"Backups","pages":[{"title":"Cleanup expired backups for a specific cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/cleanup/","href":"/enterprise/api-reference/endpoints/backups/cleanup-expired-backups-for-a-specific-cluster"},{"title":"List all backups for a specific cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/backups/","href":"/enterprise/api-reference/endpoints/backups/list-all-backups-for-a-specific-cluster"},{"title":"Create a new backup","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/backups/","href":"/enterprise/api-reference/endpoints/backups/create-a-new-backup"},{"title":"Get a specific backup","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/backups/{backupName}","href":"/enterprise/api-reference/endpoints/backups/get-a-specific-backup"},{"title":"Delete a backup","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json delete /api/clusters/{clusterName}/backups/{backupName}","href":"/enterprise/api-reference/endpoints/backups/delete-a-backup"}]},{"group":"Cluster Operations","pages":[{"title":"List all OpsRequests for a cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/ops","href":"/enterprise/api-reference/endpoints/cluster-operations/list-all-opsrequests-for-a-cluster"},{"title":"Get a specific OpsRequest","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/ops/{opsName}","href":"/enterprise/api-reference/endpoints/cluster-operations/get-a-specific-opsrequest"},{"title":"Delete an OpsRequest","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json delete /api/clusters/{clusterName}/ops/{opsName}","href":"/enterprise/api-reference/endpoints/cluster-operations/delete-an-opsrequest"},{"title":"Restart cluster component pods one-by-one with a rolling restart","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/ops/restart","href":"/enterprise/api-reference/endpoints/cluster-operations/restart-cluster-component-pods-one-by-one-with-a-rolling-restart"},{"title":"Start a previously stopped cluster","deprecated":true,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/ops/start","href":"/enterprise/api-reference/endpoints/cluster-operations/start-a-previously-stopped-cluster"},{"title":"Gracefully stop all pods in the cluster","deprecated":true,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/ops/stop","href":"/enterprise/api-reference/endpoints/cluster-operations/gracefully-stop-all-pods-in-the-cluster"},{"title":"Update runtime configuration parameters (Reconfiguring)","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/ops/configure","href":"/enterprise/api-reference/endpoints/cluster-operations/update-runtime-configuration-parameters-reconfiguring"},{"title":"Promote a replica to primary (Switchover)","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/ops/switchover","href":"/enterprise/api-reference/endpoints/cluster-operations/promote-a-replica-to-primary-switchover"},{"title":"Spread the hash slots evenly across every shard of a sharded deployment","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/ops/rebalance","href":"/enterprise/api-reference/endpoints/cluster-operations/spread-the-hash-slots-evenly-across-every-shard-of-a-sharded-deployment"},{"title":"Which shard of a sharded deployment owns which hash slots, the cluster's state, and any slots left open by a move that didn't finish","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/slots","href":"/enterprise/api-reference/endpoints/cluster-operations/which-shard-of-a-sharded-deployment-owns-which-hash-slots-the-clusters-state-and-any-slots-left-open-by-a-move-that-didnt-finish"},{"title":"Move hash slots to one shard of a sharded deployment, optionally only from another named shard","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/ops/reshard","href":"/enterprise/api-reference/endpoints/cluster-operations/move-hash-slots-to-one-shard-of-a-sharded-deployment-optionally-only-from-another-named-shard"},{"title":"Set the desired total replicas and/or shard count (HorizontalScaling)","deprecated":true,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/ops/horizontal-scale","href":"/enterprise/api-reference/endpoints/cluster-operations/set-the-desired-total-replicas-andor-shard-count-horizontalscaling"},{"title":"Adjust CPU and memory requests/limits (VerticalScaling)","deprecated":true,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/ops/vertical-scale","href":"/enterprise/api-reference/endpoints/cluster-operations/adjust-cpu-and-memory-requestslimits-verticalscaling"},{"title":"Expand PVC storage size (VolumeExpansion)","deprecated":true,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/ops/volume-expand","href":"/enterprise/api-reference/endpoints/cluster-operations/expand-pvc-storage-size-volumeexpansion"}]},{"group":"Backup Policies","pages":[{"title":"List backup policies for a specific cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/backups/policies/","href":"/enterprise/api-reference/endpoints/backup-policies/list-backup-policies-for-a-specific-cluster"},{"title":"Create a new backup policy","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/backups/policies/","href":"/enterprise/api-reference/endpoints/backup-policies/create-a-new-backup-policy"},{"title":"Get a specific backup policy","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/backups/policies/{policyName}","href":"/enterprise/api-reference/endpoints/backup-policies/get-a-specific-backup-policy"},{"title":"Delete a backup policy","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json delete /api/clusters/{clusterName}/backups/policies/{policyName}","href":"/enterprise/api-reference/endpoints/backup-policies/delete-a-backup-policy"}]},{"group":"Backup Schedules","pages":[{"title":"List all backup schedules for a specific cluster","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/backups/schedules/","href":"/enterprise/api-reference/endpoints/backup-schedules/list-all-backup-schedules-for-a-specific-cluster"},{"title":"Create a new backup schedule","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/backups/schedules/","href":"/enterprise/api-reference/endpoints/backup-schedules/create-a-new-backup-schedule"},{"title":"Get a specific backup schedule","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/backups/schedules/{scheduleName}","href":"/enterprise/api-reference/endpoints/backup-schedules/get-a-specific-backup-schedule"},{"title":"Delete a backup schedule","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json delete /api/clusters/{clusterName}/backups/schedules/{scheduleName}","href":"/enterprise/api-reference/endpoints/backup-schedules/delete-a-backup-schedule"},{"title":"Update an existing backup schedule","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json patch /api/clusters/{clusterName}/backups/schedules/{scheduleName}","href":"/enterprise/api-reference/endpoints/backup-schedules/update-an-existing-backup-schedule"}]},{"group":"Restores","pages":[{"title":"Lists the restore operations run against a cluster, with the source backup, phase, and timing of each one","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/restores/","href":"/enterprise/api-reference/endpoints/restores/lists-the-restore-operations-run-against-a-cluster-with-the-source-backup-phase-and-timing-of-each-one"},{"title":"Restore a backup into this existing deployment","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/restores/","href":"/enterprise/api-reference/endpoints/restores/restore-a-backup-into-this-existing-deployment"},{"title":"Get a specific restore","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/restores/{restoreName}","href":"/enterprise/api-reference/endpoints/restores/get-a-specific-restore"},{"title":"Delete a restore","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json delete /api/clusters/{clusterName}/restores/{restoreName}","href":"/enterprise/api-reference/endpoints/restores/delete-a-restore"},{"title":"Clone a cluster from a full backup by creating a new cluster with the restore annotation","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/restores/clone","href":"/enterprise/api-reference/endpoints/restores/clone-a-cluster-from-a-full-backup-by-creating-a-new-cluster-with-the-restore-annotation"}]},{"group":"RDB Transfers","pages":[{"title":"Lists a deployment's RDB exports and the RDB imports into it, newest first","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/transfers/","href":"/enterprise/api-reference/endpoints/rdb-transfers/lists-a-deployments-rdb-exports-and-the-rdb-imports-into-it-newest-first"},{"title":"Starts an RDB export: a Job copies the deployment's data, one RDB file per shard, into a backup repository (the default one unless `repository` is set)","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/transfers/exports","href":"/enterprise/api-reference/endpoints/rdb-transfers/starts-an-rdb-export:-a-job-copies-the-deployments-data-one-rdb-file-per-shard-into-a-backup-repository-the-default-one-unless-`repository`-is-set"},{"title":"Starts an RDB import into this deployment, from an export, an .rdb file (or directory) in a backup repository, another deployment, or a redis:// address","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/transfers/imports","href":"/enterprise/api-reference/endpoints/rdb-transfers/starts-an-rdb-import-into-this-deployment-from-an-export-an-rdb-file-or-directory-in-a-backup-repository-another-deployment-or-a-redis:-address"},{"title":"Lists a deployment's RDB export schedules","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/transfers/schedules","href":"/enterprise/api-reference/endpoints/rdb-transfers/lists-a-deployments-rdb-export-schedules"},{"title":"Creates an RDB export schedule (a CronJob)","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/transfers/schedules","href":"/enterprise/api-reference/endpoints/rdb-transfers/creates-an-rdb-export-schedule-a-cronjob"},{"title":"Gets an RDB export schedule","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/transfers/schedules/{scheduleName}","href":"/enterprise/api-reference/endpoints/rdb-transfers/gets-an-rdb-export-schedule"},{"title":"Deletes an RDB export schedule and its exports' history","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json delete /api/clusters/{clusterName}/transfers/schedules/{scheduleName}","href":"/enterprise/api-reference/endpoints/rdb-transfers/deletes-an-rdb-export-schedule-and-its-exports-history"},{"title":"Changes an RDB export schedule's cron expression, retention, or enables or disables it","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json patch /api/clusters/{clusterName}/transfers/schedules/{scheduleName}","href":"/enterprise/api-reference/endpoints/rdb-transfers/changes-an-rdb-export-schedules-cron-expression-retention-or-enables-or-disables-it"},{"title":"Starts an export from a schedule now","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/transfers/schedules/{scheduleName}/run","href":"/enterprise/api-reference/endpoints/rdb-transfers/starts-an-export-from-a-schedule-now"},{"title":"Gets an RDB export or import: its phase and, once finished, its files or key counts, or why it failed","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/transfers/{transferName}","href":"/enterprise/api-reference/endpoints/rdb-transfers/gets-an-rdb-export-or-import:-its-phase-and-once-finished-its-files-or-key-counts-or-why-it-failed"},{"title":"Deletes an RDB export or import, stopping it if it is running","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json delete /api/clusters/{clusterName}/transfers/{transferName}","href":"/enterprise/api-reference/endpoints/rdb-transfers/deletes-an-rdb-export-or-import-stopping-it-if-it-is-running"},{"title":"The logs of an RDB export or import's Job, every container","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json get /api/clusters/{clusterName}/transfers/{transferName}/logs","href":"/enterprise/api-reference/endpoints/rdb-transfers/the-logs-of-an-rdb-export-or-imports-job-every-container"},{"title":"Restores the snapshot an import took of this deployment before changing it: deletes every key, then imports the snapshot","deprecated":null,"version":null,"openapi":"/enterprise/api-reference/admin-server.json post /api/clusters/{clusterName}/transfers/{transferName}/rollback","href":"/enterprise/api-reference/endpoints/rdb-transfers/restores-the-snapshot-an-import-took-of-this-deployment-before-changing-it:-deletes-every-key-then-imports-the-snapshot"}]}]}]}]},{"product":"GraphRAG SDK","icon":"share-nodes","description":"Build knowledge graphs from documents and query them with natural language.","pages":[{"title":"GraphRAG SDK","href":"/graphrag"}]}]},"title":"Estimated cost of every deployment the caller can see, plus fleet totals - FalkorDB Docs","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}