> ## 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, 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. # Check whether the cluster has room to schedule a prospective deployment ## OpenAPI ````yaml /enterprise/api-reference/admin-server.json post /api/system/capacity-check 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:3001 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/system/capacity-check: post: tags: - System summary: Check whether the cluster has room to schedule a prospective deployment parameters: - schema: minLength: 1 type: string in: query name: namespace required: true description: namespace is required requestBody: required: true content: application/json: schema: type: object required: - topology properties: topology: additionalProperties: false type: object required: - mode properties: mode: anyOf: - type: string enum: - standalone - type: string enum: - replication - type: string enum: - cluster replicas: minimum: 1 type: integer shards: minimum: 3 type: integer replicasPerShard: minimum: 2 type: integer nodes: additionalProperties: false type: object properties: resources: additionalProperties: false type: object properties: requests: additionalProperties: false type: object properties: cpu: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: CPU, e.g. '500m' or '2' type: string memory: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: Memory, e.g. '512Mi' or '8Gi' type: string limits: additionalProperties: false type: object properties: cpu: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: CPU, e.g. '500m' or '2' type: string memory: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: Memory, e.g. '512Mi' or '8Gi' type: string storage: additionalProperties: false type: object required: - size properties: size: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: Volume size, e.g. '20Gi' type: string storageClass: minLength: 1 type: string scheduling: additionalProperties: false type: object properties: nodeSelector: type: object additionalProperties: type: string tolerations: type: array items: type: object properties: key: maxLength: 253 description: >- Taint key the toleration applies to. Empty with operator 'Exists' tolerates every taint. type: string operator: description: Defaults to 'Equal'. anyOf: - type: string enum: - Equal - type: string enum: - Exists value: maxLength: 63 description: >- Taint value to match. Must be empty when operator is 'Exists'. type: string effect: description: >- Taint effect to match. Empty matches all effects. anyOf: - type: string enum: - NoSchedule - type: string enum: - PreferNoSchedule - type: string enum: - NoExecute tolerationSeconds: minimum: 0 description: >- How long the pod stays bound to a node that acquired a NoExecute taint. Only valid with the 'NoExecute' effect. type: integer sentinels: additionalProperties: false type: object properties: replicas: minimum: 1 description: Defaults to 3 type: integer resources: additionalProperties: false type: object properties: requests: additionalProperties: false type: object properties: cpu: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: CPU, e.g. '500m' or '2' type: string memory: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: Memory, e.g. '512Mi' or '8Gi' type: string limits: additionalProperties: false type: object properties: cpu: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: CPU, e.g. '500m' or '2' type: string memory: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: Memory, e.g. '512Mi' or '8Gi' type: string storage: anyOf: - additionalProperties: false type: object required: - size properties: size: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: Volume size, e.g. '20Gi' type: string storageClass: minLength: 1 type: string - type: 'null' scheduling: additionalProperties: false type: object properties: nodeSelector: type: object additionalProperties: type: string tolerations: type: array items: type: object properties: key: maxLength: 253 description: >- Taint key the toleration applies to. Empty with operator 'Exists' tolerates every taint. type: string operator: description: Defaults to 'Equal'. anyOf: - type: string enum: - Equal - type: string enum: - Exists value: maxLength: 63 description: >- Taint value to match. Must be empty when operator is 'Exists'. type: string effect: description: >- Taint effect to match. Empty matches all effects. anyOf: - type: string enum: - NoSchedule - type: string enum: - PreferNoSchedule - type: string enum: - NoExecute tolerationSeconds: minimum: 0 description: >- How long the pod stays bound to a node that acquired a NoExecute taint. Only valid with the 'NoExecute' effect. type: integer existing: type: object required: - name - topology properties: name: minLength: 1 maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ description: >- Must be a valid Kubernetes object name: lowercase letters, numbers, and hyphens; must start and end with a letter or number; max 63 characters. type: string topology: additionalProperties: false type: object required: - mode properties: mode: anyOf: - type: string enum: - standalone - type: string enum: - replication - type: string enum: - cluster replicas: minimum: 1 type: integer shards: minimum: 3 type: integer replicasPerShard: minimum: 2 type: integer nodes: additionalProperties: false type: object properties: resources: additionalProperties: false type: object properties: requests: additionalProperties: false type: object properties: cpu: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: CPU, e.g. '500m' or '2' type: string memory: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: Memory, e.g. '512Mi' or '8Gi' type: string limits: additionalProperties: false type: object properties: cpu: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: CPU, e.g. '500m' or '2' type: string memory: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: Memory, e.g. '512Mi' or '8Gi' type: string storage: additionalProperties: false type: object required: - size properties: size: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: Volume size, e.g. '20Gi' type: string storageClass: minLength: 1 type: string scheduling: additionalProperties: false type: object properties: nodeSelector: type: object additionalProperties: type: string tolerations: type: array items: type: object properties: key: maxLength: 253 description: >- Taint key the toleration applies to. Empty with operator 'Exists' tolerates every taint. type: string operator: description: Defaults to 'Equal'. anyOf: - type: string enum: - Equal - type: string enum: - Exists value: maxLength: 63 description: >- Taint value to match. Must be empty when operator is 'Exists'. type: string effect: description: >- Taint effect to match. Empty matches all effects. anyOf: - type: string enum: - NoSchedule - type: string enum: - PreferNoSchedule - type: string enum: - NoExecute tolerationSeconds: minimum: 0 description: >- How long the pod stays bound to a node that acquired a NoExecute taint. Only valid with the 'NoExecute' effect. type: integer sentinels: additionalProperties: false type: object properties: replicas: minimum: 1 description: Defaults to 3 type: integer resources: additionalProperties: false type: object properties: requests: additionalProperties: false type: object properties: cpu: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: CPU, e.g. '500m' or '2' type: string memory: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: Memory, e.g. '512Mi' or '8Gi' type: string limits: additionalProperties: false type: object properties: cpu: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: CPU, e.g. '500m' or '2' type: string memory: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: Memory, e.g. '512Mi' or '8Gi' type: string storage: anyOf: - additionalProperties: false type: object required: - size properties: size: minLength: 1 pattern: ^[0-9]+(\.[0-9]+)?(m|Ki|Mi|Gi|Ti|k|M|G|T)?$ description: Volume size, e.g. '20Gi' type: string storageClass: minLength: 1 type: string - type: 'null' scheduling: additionalProperties: false type: object properties: nodeSelector: type: object additionalProperties: type: string tolerations: type: array items: type: object properties: key: maxLength: 253 description: >- Taint key the toleration applies to. Empty with operator 'Exists' tolerates every taint. type: string operator: description: Defaults to 'Equal'. anyOf: - type: string enum: - Equal - type: string enum: - Exists value: maxLength: 63 description: >- Taint value to match. Must be empty when operator is 'Exists'. type: string effect: description: >- Taint effect to match. Empty matches all effects. anyOf: - type: string enum: - NoSchedule - type: string enum: - PreferNoSchedule - type: string enum: - NoExecute tolerationSeconds: minimum: 0 description: >- How long the pod stays bound to a node that acquired a NoExecute taint. Only valid with the 'NoExecute' effect. type: integer responses: '200': description: Default Response content: application/json: schema: type: object required: - checkedAt - status - required - available - unplaced - storage - issues - notes properties: checkedAt: format: date-time type: string status: anyOf: - type: string enum: - fits - type: string enum: - insufficient - type: string enum: - unknown - type: string enum: - disabled required: type: object required: - pods - cpu - memory - storage properties: pods: minimum: 0 type: integer cpu: type: number memory: type: number storage: type: number available: type: object required: - nodes - cpu - memory properties: nodes: minimum: 0 type: integer cpu: type: number memory: type: number unplaced: type: array items: type: object required: - component - count - cpu - memory properties: component: type: string count: minimum: 0 type: integer cpu: type: number memory: type: number storage: type: array items: type: object required: - storageClass - required - volumeCount - status properties: storageClass: anyOf: - type: string - type: 'null' required: type: number volumeCount: minimum: 0 type: integer status: anyOf: - type: string enum: - ok - type: string enum: - dynamic - type: string enum: - insufficient - type: string enum: - missing issues: type: array items: type: object required: - severity - message properties: severity: anyOf: - type: string enum: - error - type: string enum: - warning message: type: string notes: type: array items: type: string '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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.