> ## 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 a specific backup repository



## OpenAPI

````yaml /api-reference/admin-server.json get /api/backups/repositories/{name}
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/backups/repositories/{name}:
    get:
      tags:
        - Backup Repositories
      summary: Get a specific backup repository
      parameters:
        - schema:
            type: string
          in: path
          name: name
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    required:
                      - name
                      - isDefault
                      - createdAt
                      - status
                      - type
                      - config
                    properties:
                      name:
                        type: string
                      storageProviderRef:
                        type: string
                      isDefault:
                        type: boolean
                      createdAt:
                        type: string
                      status:
                        anyOf:
                          - type: string
                            enum:
                              - ready
                          - type: string
                            enum:
                              - error
                          - type: string
                            enum:
                              - pending
                      statusMessage:
                        type: string
                      type:
                        type: string
                        enum:
                          - s3
                      config:
                        type: object
                        required:
                          - bucket
                          - region
                        properties:
                          bucket:
                            description: S3 bucket name
                            type: string
                          region:
                            description: AWS region, e.g. us-west-1
                            type: string
                          endpoint:
                            description: S3 endpoint (optional, overrides default)
                            type: string
                          insecure:
                            description: Disable server SSL certificate verification
                            type: boolean
                          noCheckBucket:
                            description: Skip bucket existence check / creation
                            type: boolean
                          geesefsMemoryLimit:
                            description: Memory limit for geesefs in MB
                            type: integer
                          geesefsReadAheadLarge:
                            description: Read-ahead-large for geesefs in KB
                            type: integer
                          mountOptions:
                            description: Extra mount options for geesefs
                            type: string
                  - type: object
                    required:
                      - name
                      - isDefault
                      - createdAt
                      - status
                      - type
                      - config
                    properties:
                      name:
                        type: string
                      storageProviderRef:
                        type: string
                      isDefault:
                        type: boolean
                      createdAt:
                        type: string
                      status:
                        anyOf:
                          - type: string
                            enum:
                              - ready
                          - type: string
                            enum:
                              - error
                          - type: string
                            enum:
                              - pending
                      statusMessage:
                        type: string
                      type:
                        type: string
                        enum:
                          - s3-compatible
                      config:
                        type: object
                        required:
                          - bucket
                          - endpoint
                        properties:
                          bucket:
                            description: Bucket name
                            type: string
                          endpoint:
                            description: S3-compatible storage endpoint
                            type: string
                          region:
                            description: Region, e.g. us-west-1
                            type: string
                          serviceProvider:
                            description: >-
                              rclone provider name
                              (https://rclone.org/s3/#configuration), e.g.
                              DigitalOcean
                            type: string
                          forcePathStyle:
                            description: >-
                              Force path-style access instead of
                              virtual-hosted-style
                            type: boolean
                          insecure:
                            description: Disable server SSL certificate verification
                            type: boolean
                          noCheckBucket:
                            description: Skip bucket existence check / creation
                            type: boolean
                          geesefsMemoryLimit:
                            description: Memory limit for geesefs in MB
                            type: integer
                          geesefsReadAheadLarge:
                            description: Read-ahead-large for geesefs in KB
                            type: integer
                          mountOptions:
                            description: Extra mount options for geesefs
                            type: string
                  - type: object
                    required:
                      - name
                      - isDefault
                      - createdAt
                      - status
                      - type
                      - config
                    properties:
                      name:
                        type: string
                      storageProviderRef:
                        type: string
                      isDefault:
                        type: boolean
                      createdAt:
                        type: string
                      status:
                        anyOf:
                          - type: string
                            enum:
                              - ready
                          - type: string
                            enum:
                              - error
                          - type: string
                            enum:
                              - pending
                      statusMessage:
                        type: string
                      type:
                        type: string
                        enum:
                          - gcs-s3comp
                      config:
                        type: object
                        required:
                          - bucket
                          - region
                        properties:
                          bucket:
                            description: GCS bucket (must already exist)
                            type: string
                          region:
                            description: GCS region, e.g. auto
                            type: string
                          endpoint:
                            description: >-
                              GCS endpoint (default:
                              https://storage.googleapis.com)
                            type: string
                          insecure:
                            description: Disable server SSL certificate verification
                            type: boolean
                          geesefsMemoryLimit:
                            description: Memory limit for geesefs in MB
                            type: integer
                          geesefsReadAheadLarge:
                            description: Read-ahead-large for geesefs in KB
                            type: integer
                          mountOptions:
                            description: Extra mount options for geesefs
                            type: string
                  - type: object
                    required:
                      - name
                      - isDefault
                      - createdAt
                      - status
                      - type
                      - config
                    properties:
                      name:
                        type: string
                      storageProviderRef:
                        type: string
                      isDefault:
                        type: boolean
                      createdAt:
                        type: string
                      status:
                        anyOf:
                          - type: string
                            enum:
                              - ready
                          - type: string
                            enum:
                              - error
                          - type: string
                            enum:
                              - pending
                      statusMessage:
                        type: string
                      type:
                        type: string
                        enum:
                          - azureblob
                      config:
                        type: object
                        required:
                          - container
                        properties:
                          container:
                            description: Azure Blob Storage container name
                            type: string
                          endpoint:
                            description: Azure Blob Storage endpoint (optional)
                            type: string
                          noCheckContainer:
                            description: Skip container existence check / creation
                            type: boolean
                  - type: object
                    required:
                      - name
                      - isDefault
                      - createdAt
                      - status
                      - type
                      - config
                    properties:
                      name:
                        type: string
                      storageProviderRef:
                        type: string
                      isDefault:
                        type: boolean
                      createdAt:
                        type: string
                      status:
                        anyOf:
                          - type: string
                            enum:
                              - ready
                          - type: string
                            enum:
                              - error
                          - type: string
                            enum:
                              - pending
                      statusMessage:
                        type: string
                      type:
                        type: string
                        enum:
                          - nfs
                      config:
                        type: object
                        required:
                          - nfsServer
                        properties:
                          nfsServer:
                            description: NFS server address
                            type: string
                          nfsShare:
                            description: NFS share path
                            type: string
                          nfsSubDir:
                            description: Sub-directory under the NFS share
                            type: string
                          nfsMountOptions:
                            description: Extra NFS mount options
                            type: string
                  - type: object
                    required:
                      - name
                      - isDefault
                      - createdAt
                      - status
                      - type
                      - config
                    properties:
                      name:
                        type: string
                      storageProviderRef:
                        type: string
                      isDefault:
                        type: boolean
                      createdAt:
                        type: string
                      status:
                        anyOf:
                          - type: string
                            enum:
                              - ready
                          - type: string
                            enum:
                              - error
                          - type: string
                            enum:
                              - pending
                      statusMessage:
                        type: string
                      type:
                        type: string
                        enum:
                          - pvc
                      config:
                        type: object
                        properties:
                          storageClassName:
                            description: Name of the StorageClass used to create the PVC
                            type: string
                          accessMode:
                            description: PVC access mode
                            anyOf:
                              - type: string
                                enum:
                                  - ReadWriteOnce
                              - type: string
                                enum:
                                  - ReadWriteMany
                              - type: string
                                enum:
                                  - ReadWriteOncePod
                          volumeMode:
                            description: PVC volume mode
                            anyOf:
                              - type: string
                                enum:
                                  - Filesystem
                              - type: string
                                enum:
                                  - Block
                  - type: object
                    required:
                      - name
                      - isDefault
                      - createdAt
                      - status
                      - type
                      - config
                    properties:
                      name:
                        type: string
                      storageProviderRef:
                        type: string
                      isDefault:
                        type: boolean
                      createdAt:
                        type: string
                      status:
                        anyOf:
                          - type: string
                            enum:
                              - ready
                          - type: string
                            enum:
                              - error
                          - type: string
                            enum:
                              - pending
                      statusMessage:
                        type: string
                      type:
                        type: string
                        enum:
                          - minio
                      config:
                        type: object
                        required:
                          - bucket
                          - endpoint
                        properties:
                          bucket:
                            description: MinIO bucket name
                            type: string
                          endpoint:
                            description: MinIO endpoint URL
                            type: string
                          region:
                            description: MinIO region (optional), e.g. us-west-1
                            type: string
                          insecure:
                            description: Disable server SSL certificate verification
                            type: boolean
                          noCheckBucket:
                            description: Skip bucket existence check / creation
                            type: boolean
                          geesefsMemoryLimit:
                            description: Memory limit for geesefs in MB
                            type: integer
                          geesefsReadAheadLarge:
                            description: Read-ahead-large for geesefs in KB
                            type: integer
                          mountOptions:
                            description: Extra mount options for geesefs
                            type: string
                  - type: object
                    required:
                      - name
                      - isDefault
                      - createdAt
                      - status
                      - type
                      - config
                    properties:
                      name:
                        type: string
                      storageProviderRef:
                        type: string
                      isDefault:
                        type: boolean
                      createdAt:
                        type: string
                      status:
                        anyOf:
                          - type: string
                            enum:
                              - ready
                          - type: string
                            enum:
                              - error
                          - type: string
                            enum:
                              - pending
                      statusMessage:
                        type: string
                      type:
                        type: string
                        enum:
                          - cos
                      config:
                        type: object
                        required:
                          - bucket
                          - region
                        properties:
                          bucket:
                            description: COS bucket name
                            type: string
                          region:
                            description: COS region, e.g. cn-guangzhou
                            type: string
                          endpoint:
                            description: >-
                              COS endpoint (default:
                              https://cos.<region>.myqcloud.com)
                            type: string
                          insecure:
                            description: Disable server SSL certificate verification
                            type: boolean
                          noCheckBucket:
                            description: Skip bucket existence check / creation
                            type: boolean
                          geesefsMemoryLimit:
                            description: Memory limit for geesefs in MB
                            type: integer
                          geesefsReadAheadLarge:
                            description: Read-ahead-large for geesefs in KB
                            type: integer
                          mountOptions:
                            description: Extra mount options for geesefs
                            type: string
                  - type: object
                    required:
                      - name
                      - isDefault
                      - createdAt
                      - status
                      - type
                      - config
                    properties:
                      name:
                        type: string
                      storageProviderRef:
                        type: string
                      isDefault:
                        type: boolean
                      createdAt:
                        type: string
                      status:
                        anyOf:
                          - type: string
                            enum:
                              - ready
                          - type: string
                            enum:
                              - error
                          - type: string
                            enum:
                              - pending
                      statusMessage:
                        type: string
                      type:
                        type: string
                        enum:
                          - ftp
                      config:
                        type: object
                        required:
                          - ftpHost
                        properties:
                          ftpHost:
                            description: FTP server host
                            type: string
                          ftpPort:
                            description: 'FTP server port (default: 21)'
                            type: integer
                          ftpTls:
                            description: Enable FTP over TLS
                            type: boolean
                  - type: object
                    required:
                      - name
                      - isDefault
                      - createdAt
                      - status
                      - type
                      - config
                    properties:
                      name:
                        type: string
                      storageProviderRef:
                        type: string
                      isDefault:
                        type: boolean
                      createdAt:
                        type: string
                      status:
                        anyOf:
                          - type: string
                            enum:
                              - ready
                          - type: string
                            enum:
                              - error
                          - type: string
                            enum:
                              - pending
                      statusMessage:
                        type: string
                      type:
                        type: string
                        enum:
                          - obs
                      config:
                        type: object
                        required:
                          - bucket
                          - region
                        properties:
                          bucket:
                            description: OBS bucket name
                            type: string
                          region:
                            description: OBS region, e.g. cn-north-4
                            type: string
                          endpoint:
                            description: >-
                              OBS endpoint (default:
                              https://obs.<region>.myhuaweicloud.com)
                            type: string
                          insecure:
                            description: Disable server SSL certificate verification
                            type: boolean
                          noCheckBucket:
                            description: Skip bucket existence check / creation
                            type: boolean
                          geesefsMemoryLimit:
                            description: Memory limit for geesefs in MB
                            type: integer
                          geesefsReadAheadLarge:
                            description: Read-ahead-large for geesefs in KB
                            type: integer
                          mountOptions:
                            description: Extra mount options for geesefs
                            type: string
                  - type: object
                    required:
                      - name
                      - isDefault
                      - createdAt
                      - status
                      - type
                      - config
                    properties:
                      name:
                        type: string
                      storageProviderRef:
                        type: string
                      isDefault:
                        type: boolean
                      createdAt:
                        type: string
                      status:
                        anyOf:
                          - type: string
                            enum:
                              - ready
                          - type: string
                            enum:
                              - error
                          - type: string
                            enum:
                              - pending
                      statusMessage:
                        type: string
                      type:
                        type: string
                        enum:
                          - oss
                      config:
                        type: object
                        required:
                          - bucket
                          - region
                        properties:
                          bucket:
                            description: OSS bucket name
                            type: string
                          region:
                            description: OSS region, e.g. cn-hangzhou
                            type: string
                          endpoint:
                            description: >-
                              OSS endpoint (default:
                              https://oss-<region>.aliyuncs.com)
                            type: string
                          insecure:
                            description: Disable server SSL certificate verification
                            type: boolean
                          noCheckBucket:
                            description: Skip bucket existence check / creation
                            type: boolean
                          geesefsMemoryLimit:
                            description: Memory limit for geesefs in MB
                            type: integer
                          geesefsReadAheadLarge:
                            description: Read-ahead-large for geesefs in KB
                            type: integer
                          mountOptions:
                            description: Extra mount options for geesefs
                            type: string
        '404':
          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

````