> ## 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. # List all clusters ## OpenAPI ````yaml /api-reference/admin-server.json get /api/clusters/ 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/: get: tags: - Clusters summary: List all clusters parameters: - schema: minLength: 1 type: string in: query name: namespace required: false responses: '200': description: Default Response content: application/json: schema: type: object required: - clusters - total properties: clusters: type: array items: additionalProperties: true type: object required: - name - namespace - state - replicas - version properties: name: type: string namespace: type: string creationTimestamp: type: string state: anyOf: - type: string enum: - Pending - type: string enum: - Running - type: string enum: - Stopping - type: string enum: - Stopped - type: string enum: - Deleting - type: string enum: - Failed - type: string enum: - Degraded - type: string enum: - Unknown topology: anyOf: - type: string enum: - standalone - type: string enum: - replication - type: string enum: - cluster replicas: type: number version: type: string componentDefinition: type: string 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 services: type: array items: type: object required: - name - serviceType properties: name: minLength: 1 maxLength: 25 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 serviceType: anyOf: - type: string enum: - ClusterIP - type: string enum: - NodePort - type: string enum: - LoadBalancer annotations: type: object additionalProperties: type: string podService: type: boolean modules: additionalProperties: false type: object properties: falkordb: additionalProperties: false type: object properties: config: additionalProperties: false description: >- FalkorDB configuration key-value map that will be encoded into the FALKORDB_ARGS environment variable. type: object properties: THREAD_COUNT: minLength: 1 pattern: ^[0-9]+$ description: 'Default: ' type: string CACHE_SIZE: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 25' type: string OMP_THREAD_COUNT: minLength: 1 pattern: ^[0-9]+$ description: 'Default: ' type: string NODE_CREATION_BUFFER: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 16384' type: string BOLT_PORT: minLength: 1 pattern: ^(-1|[0-9]+)$ description: 'Default: -1' type: string MAX_QUEUED_QUERIES: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 9007199254740991' type: string TIMEOUT_MAX: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 0' type: string TIMEOUT_DEFAULT: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 0' type: string RESULTSET_SIZE: minLength: 1 pattern: ^(-1|[0-9]+)$ description: 'Default: -1' type: string QUERY_MEM_CAPACITY: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 0' type: string VKEY_MAX_ENTITY_COUNT: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 100000' type: string EFFECTS_THRESHOLD: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 300' type: string CMD_INFO: minLength: 1 pattern: ^(no)$ description: 'Default: ' type: string MAX_INFO_QUERIES: minLength: 1 pattern: ^(1000|[1-9][0-9]{0,2}|0)$ description: 'Default: 1000' type: string DELTA_MAX_PENDING_CHANGES: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 10000' type: string IMPORT_FOLDER: minLength: 1 pattern: ^/.*$ description: 'Default: /var/lib/FalkorDB/import/' type: string falkordbArgs: additionalProperties: false description: >- FalkorDB configuration key-value map that will be encoded into the FALKORDB_ARGS environment variable. type: object properties: THREAD_COUNT: minLength: 1 pattern: ^[0-9]+$ description: 'Default: ' type: string CACHE_SIZE: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 25' type: string OMP_THREAD_COUNT: minLength: 1 pattern: ^[0-9]+$ description: 'Default: ' type: string NODE_CREATION_BUFFER: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 16384' type: string BOLT_PORT: minLength: 1 pattern: ^(-1|[0-9]+)$ description: 'Default: -1' type: string MAX_QUEUED_QUERIES: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 9007199254740991' type: string TIMEOUT_MAX: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 0' type: string TIMEOUT_DEFAULT: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 0' type: string RESULTSET_SIZE: minLength: 1 pattern: ^(-1|[0-9]+)$ description: 'Default: -1' type: string QUERY_MEM_CAPACITY: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 0' type: string VKEY_MAX_ENTITY_COUNT: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 100000' type: string EFFECTS_THRESHOLD: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 300' type: string CMD_INFO: minLength: 1 pattern: ^(no)$ description: 'Default: ' type: string MAX_INFO_QUERIES: minLength: 1 pattern: ^(1000|[1-9][0-9]{0,2}|0)$ description: 'Default: 1000' type: string DELTA_MAX_PENDING_CHANGES: minLength: 1 pattern: ^[0-9]+$ description: 'Default: 10000' type: string IMPORT_FOLDER: minLength: 1 pattern: ^/.*$ description: 'Default: /var/lib/FalkorDB/import/' type: string sentinel: type: object required: - enabled properties: enabled: type: boolean replicas: minimum: 1 type: integer componentDefinition: minLength: 1 type: string 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 services: type: array items: type: object required: - name - serviceType properties: name: minLength: 1 maxLength: 25 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 serviceType: anyOf: - type: string enum: - ClusterIP - type: string enum: - NodePort - type: string enum: - LoadBalancer annotations: type: object additionalProperties: type: string podService: type: boolean sharding: type: object required: - enabled properties: enabled: type: boolean shardCount: minimum: 3 type: integer replicas: minimum: 2 type: integer 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 services: type: array items: type: object required: - name - serviceType properties: name: minLength: 1 maxLength: 25 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 serviceType: anyOf: - type: string enum: - ClusterIP - type: string enum: - NodePort - type: string enum: - LoadBalancer annotations: type: object additionalProperties: type: string podService: type: boolean externalDomain: minLength: 1 maxLength: 253 pattern: >- ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$ description: >- DNS domain under which per-pod records are published, e.g. 'db.internal.example.com'. Requires routable pod IPs and an ExternalDNS instance. type: string labels: type: object additionalProperties: type: string annotations: type: object additionalProperties: type: string status: type: object properties: state: type: string ready: type: boolean replicas: type: number readyReplicas: type: number conditions: type: array items: type: object required: - type - status properties: type: type: string status: type: string reason: type: string message: type: string lastTransitionTime: type: string total: type: number '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 ````