> ## Documentation Index
> Fetch the complete documentation index at: https://docs.falkordb.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent 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, but they are separate products. Do not present RedisGraph commands, versions, or limitations as current FalkorDB behavior.
> 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.

# Estimate the cost of a prospective deployment spec, for create and scale flows

> Estimate the cost of a prospective deployment spec, for create and scale flows. Reads no existing deployments.



## OpenAPI

````yaml /enterprise/api-reference/admin-server.json post /api/clusters/costs/estimate
openapi: 3.1.0
info:
  title: FalkorDB Admin API
  description: REST API for managing FalkorDB clusters, backups, and users via KubeBlocks
  version: 1.0.0
  contact:
    name: FalkorDB
    url: https://falkordb.com
    email: support@falkordb.com
servers:
  - url: http://localhost:3000
    description: Development server
security:
  - cookieAuth: []
tags:
  - name: System
    description: System health and info endpoints
  - name: Authentication
    description: User authentication endpoints
  - name: OAuth
    description: OAuth 2.0 sign-in flows
  - name: Users
    description: User management endpoints
  - name: User Profile
    description: Signed-in user profile and password
  - name: Clusters
    description: Cluster management endpoints
  - name: Cluster Operations
    description: 'KubeBlocks OpsRequests: restart, scale, reconfigure, switchover'
  - name: Backups
    description: Backup management endpoints
  - name: Backup Policies
    description: Backup policy management endpoints
  - name: Backup Schedules
    description: Recurring backup schedules
  - name: Backup Repositories
    description: Backup repository management
  - name: Restores
    description: Restore a deployment from a backup
  - name: Settings
    description: System settings endpoints
  - name: RBAC
    description: Role-based access control
  - name: Licensing
    description: License status and activation
  - name: Audit
    description: Audit log endpoints
  - name: Metrics
    description: System, deployment, and pod metrics
  - name: Diagnostics
    description: Health checks, diagnostics, and support packages
  - name: Search
    description: Cross-resource search
paths:
  /api/clusters/costs/estimate:
    post:
      tags:
        - Clusters
      summary: >-
        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.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                topology:
                  anyOf:
                    - type: string
                      enum:
                        - standalone
                    - type: string
                      enum:
                        - replication
                    - type: string
                      enum:
                        - cluster
                replicas:
                  minimum: 0
                  type: number
                resources:
                  type: object
                  properties:
                    limits:
                      type: object
                      properties:
                        cpu:
                          pattern: ^[0-9]+m?$
                          description: CPU in cores (e.g., '500m' for 0.5 cores)
                          type: string
                        memory:
                          pattern: ^[0-9]+(Mi|Gi)?$
                          description: Memory in bytes (e.g., '512Mi' for 512 MiB)
                          type: string
                    requests:
                      type: object
                      properties:
                        cpu:
                          pattern: ^[0-9]+m?$
                          description: CPU in cores (e.g., '500m' for 0.5 cores)
                          type: string
                        memory:
                          pattern: ^[0-9]+(Mi|Gi)?$
                          description: Memory in bytes (e.g., '512Mi' for 512 MiB)
                          type: string
                persistence:
                  type: object
                  required:
                    - enabled
                  properties:
                    enabled:
                      type: boolean
                    storageClass:
                      type: string
                    size:
                      type: string
                    accessMode:
                      type: string
                sentinel:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                    replicas:
                      minimum: 0
                      type: number
                    resources:
                      type: object
                      properties:
                        limits:
                          type: object
                          properties:
                            cpu:
                              pattern: ^[0-9]+m?$
                              description: CPU in cores (e.g., '500m' for 0.5 cores)
                              type: string
                            memory:
                              pattern: ^[0-9]+(Mi|Gi)?$
                              description: Memory in bytes (e.g., '512Mi' for 512 MiB)
                              type: string
                        requests:
                          type: object
                          properties:
                            cpu:
                              pattern: ^[0-9]+m?$
                              description: CPU in cores (e.g., '500m' for 0.5 cores)
                              type: string
                            memory:
                              pattern: ^[0-9]+(Mi|Gi)?$
                              description: Memory in bytes (e.g., '512Mi' for 512 MiB)
                              type: string
                    persistence:
                      type: object
                      required:
                        - enabled
                      properties:
                        enabled:
                          type: boolean
                        storageClass:
                          type: string
                        size:
                          type: string
                        accessMode:
                          type: string
                sharding:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                    shardCount:
                      minimum: 0
                      type: number
                    replicas:
                      minimum: 0
                      type: number
                    resources:
                      type: object
                      properties:
                        limits:
                          type: object
                          properties:
                            cpu:
                              pattern: ^[0-9]+m?$
                              description: CPU in cores (e.g., '500m' for 0.5 cores)
                              type: string
                            memory:
                              pattern: ^[0-9]+(Mi|Gi)?$
                              description: Memory in bytes (e.g., '512Mi' for 512 MiB)
                              type: string
                        requests:
                          type: object
                          properties:
                            cpu:
                              pattern: ^[0-9]+m?$
                              description: CPU in cores (e.g., '500m' for 0.5 cores)
                              type: string
                            memory:
                              pattern: ^[0-9]+(Mi|Gi)?$
                              description: Memory in bytes (e.g., '512Mi' for 512 MiB)
                              type: string
                    persistence:
                      type: object
                      required:
                        - enabled
                      properties:
                        enabled:
                          type: boolean
                        storageClass:
                          type: string
                        size:
                          type: string
                        accessMode:
                          type: string
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - provider
                  - configured
                  - estimated
                  - footprint
                  - warnings
                properties:
                  provider:
                    anyOf:
                      - type: string
                        enum:
                          - rate-card
                      - type: string
                        enum:
                          - opencost
                      - type: string
                        enum:
                          - none
                  configured:
                    type: boolean
                  estimated:
                    type: boolean
                    enum:
                      - true
                  currency:
                    type: string
                  footprint:
                    type: object
                    required:
                      - cpuCores
                      - memoryGb
                      - storageGb
                      - components
                    properties:
                      cpuCores:
                        minimum: 0
                        type: number
                      memoryGb:
                        minimum: 0
                        type: number
                      storageGb:
                        minimum: 0
                        type: 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
                            replicas:
                              minimum: 0
                              type: number
                            cpuCores:
                              minimum: 0
                              description: Reserved CPU cores across all replicas
                              type: number
                            memoryGb:
                              minimum: 0
                              description: Reserved memory GB across all replicas
                              type: number
                            storageGb:
                              minimum: 0
                              description: Provisioned storage GB across all replicas
                              type: number
                            storageClass:
                              type: string
                  cost:
                    type: object
                    required:
                      - cpu
                      - memory
                      - storage
                      - total
                    properties:
                      cpu:
                        type: object
                        required:
                          - hourly
                          - monthly
                        properties:
                          hourly:
                            minimum: 0
                            type: number
                          monthly:
                            minimum: 0
                            type: number
                      memory:
                        type: object
                        required:
                          - hourly
                          - monthly
                        properties:
                          hourly:
                            minimum: 0
                            type: number
                          monthly:
                            minimum: 0
                            type: number
                      storage:
                        type: object
                        required:
                          - hourly
                          - monthly
                        properties:
                          hourly:
                            minimum: 0
                            type: number
                          monthly:
                            minimum: 0
                            type: number
                      total:
                        type: object
                        required:
                          - hourly
                          - monthly
                        properties:
                          hourly:
                            minimum: 0
                            type: number
                          monthly:
                            minimum: 0
                            type: number
                  warnings:
                    type: array
                    items:
                      anyOf:
                        - type: string
                          enum:
                            - no-cpu-request
                        - type: string
                          enum:
                            - no-memory-request
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  statusCode:
                    type: number
                  error:
                    type: string
                  message:
                    type: string
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  statusCode:
                    type: number
                  error:
                    type: string
                  message:
                    type: string
      security:
        - cookieAuth: []
components:
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: token
      description: JWT token stored in HTTP-only cookie

````