> ## 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 all admin settings



## OpenAPI

````yaml /api-reference/admin-server.json get /api/settings/
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/settings/:
    get:
      tags:
        - Settings
      summary: Get all admin settings
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - features
                  - oauth
                  - retention
                  - metrics
                properties:
                  features:
                    type: object
                    required:
                      - oauth2_enabled
                      - local_users_enabled
                      - self_service_onboarding
                      - multi_cluster_mode
                      - backup_auto_schedule
                      - metrics_collection
                      - api_docs_enabled
                    properties:
                      oauth2_enabled:
                        type: boolean
                      local_users_enabled:
                        type: boolean
                      self_service_onboarding:
                        type: boolean
                      multi_cluster_mode:
                        type: boolean
                      backup_auto_schedule:
                        type: boolean
                      metrics_collection:
                        type: boolean
                      api_docs_enabled:
                        type: boolean
                  oauth:
                    type: object
                    required:
                      - allowed_domains
                    properties:
                      allowed_domains:
                        type: array
                        items:
                          type: string
                      role_attribute_path:
                        type: string
                      role_attribute_strict:
                        type: boolean
                  google_oauth:
                    type: object
                    properties:
                      client_id:
                        type: string
                      redirect_uri:
                        type: string
                      client_secret_secret_ref:
                        type: string
                  azure_oauth:
                    type: object
                    properties:
                      client_id:
                        type: string
                      tenant_id:
                        type: string
                      redirect_uri:
                        type: string
                      client_secret_secret_ref:
                        type: string
                  google_workspace:
                    type: object
                    properties:
                      domain:
                        type: string
                      admin_email:
                        format: email
                        type: string
                      private_key_secret_ref:
                        type: string
                  retention:
                    type: object
                    required:
                      - audit_log_retention_days
                      - metrics_retention_days
                    properties:
                      audit_log_retention_days:
                        minimum: 1
                        type: integer
                      metrics_retention_days:
                        minimum: 1
                        type: integer
                  metrics:
                    type: object
                    required:
                      - prometheus_port
                    properties:
                      prometheus_port:
                        minimum: 1
                        maximum: 65535
                        type: integer
                  ui:
                    type: object
                    properties:
                      browser_url:
                        description: Base URL for the FalkorDB Browser integration
                        type: string
                      dm_sql_url:
                        description: Base URL for the DM-SQL integration
                        type: string
                      grafana_url:
                        description: Base URL for the Grafana dashboard integration
                        type: string
                      prometheus_url:
                        description: Base URL for the Prometheus-compatible metrics store
                        type: string
                      log_store_url:
                        description: >-
                          Base URL for the Loki/VictoriaLogs-compatible log
                          store
                        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

````