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

# Get aggregated cluster CPU/memory/storage capacity and deployment vs support usage split



## OpenAPI

````yaml /api-reference/admin-server.json get /api/system/cluster-resources
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/system/cluster-resources:
    get:
      tags:
        - System
      summary: >-
        Get aggregated cluster CPU/memory/storage capacity and deployment vs
        support usage split
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - timestamp
                  - cpu
                  - memory
                  - storage
                  - availableForDeployments
                  - supportBreakdown
                  - scope
                  - notes
                properties:
                  timestamp:
                    format: date-time
                    type: string
                  cpu:
                    type: object
                    required:
                      - total
                      - usedByDeployments
                      - usedBySupport
                      - usedTotal
                      - available
                      - breakdown
                    properties:
                      total:
                        type: number
                      usedByDeployments:
                        type: number
                      usedBySupport:
                        type: number
                      usedTotal:
                        type: number
                      available:
                        type: number
                      breakdown:
                        type: object
                        required:
                          - system
                          - falkordbEnterprise
                          - falkordbDeployments
                          - other
                          - available
                        properties:
                          system:
                            type: number
                          falkordbEnterprise:
                            type: number
                          falkordbDeployments:
                            type: number
                          other:
                            type: number
                          available:
                            type: number
                  memory:
                    type: object
                    required:
                      - total
                      - usedByDeployments
                      - usedBySupport
                      - usedTotal
                      - available
                      - breakdown
                    properties:
                      total:
                        type: number
                      usedByDeployments:
                        type: number
                      usedBySupport:
                        type: number
                      usedTotal:
                        type: number
                      available:
                        type: number
                      breakdown:
                        type: object
                        required:
                          - system
                          - falkordbEnterprise
                          - falkordbDeployments
                          - other
                          - available
                        properties:
                          system:
                            type: number
                          falkordbEnterprise:
                            type: number
                          falkordbDeployments:
                            type: number
                          other:
                            type: number
                          available:
                            type: number
                  storage:
                    type: object
                    required:
                      - capacityKnown
                      - total
                      - usedByDeployments
                      - usedBySupport
                      - usedTotal
                      - available
                      - breakdown
                    properties:
                      capacityKnown:
                        type: boolean
                      total:
                        anyOf:
                          - type: number
                          - type: 'null'
                      usedByDeployments:
                        type: number
                      usedBySupport:
                        type: number
                      usedTotal:
                        type: number
                      available:
                        anyOf:
                          - type: number
                          - type: 'null'
                      breakdown:
                        type: object
                        required:
                          - system
                          - falkordbEnterprise
                          - falkordbDeployments
                          - other
                          - available
                        properties:
                          system:
                            type: number
                          falkordbEnterprise:
                            type: number
                          falkordbDeployments:
                            type: number
                          other:
                            type: number
                          available:
                            anyOf:
                              - type: number
                              - type: 'null'
                  availableForDeployments:
                    type: object
                    required:
                      - cpu
                      - memory
                      - storage
                      - limitingResource
                    properties:
                      cpu:
                        type: number
                      memory:
                        type: number
                      storage:
                        anyOf:
                          - type: number
                          - type: 'null'
                      limitingResource:
                        anyOf:
                          - type: string
                            enum:
                              - cpu
                          - type: string
                            enum:
                              - memory
                          - type: string
                            enum:
                              - storage
                          - type: string
                            enum:
                              - unknown
                  supportBreakdown:
                    type: array
                    items:
                      type: object
                      required:
                        - component
                        - cpu
                        - memory
                        - storage
                        - podCount
                        - persistentVolumeClaimCount
                      properties:
                        component:
                          type: string
                        cpu:
                          type: number
                        memory:
                          type: number
                        storage:
                          type: number
                        podCount:
                          type: integer
                        persistentVolumeClaimCount:
                          type: integer
                  scope:
                    type: object
                    required:
                      - mode
                      - namespaces
                    properties:
                      mode:
                        anyOf:
                          - type: string
                            enum:
                              - cluster-wide
                          - type: string
                            enum:
                              - namespace-filtered
                      namespaces:
                        anyOf:
                          - type: array
                            items:
                              type: string
                          - type: 'null'
                  notes:
                    type: array
                    items:
                      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

````