Longhorn Manager API — Backups

naftiko: 1.0.0-alpha2
info:
  label: Longhorn Manager API — Backups
  description: 'Longhorn Manager API — Backups. 4 operations. Lead operation: Longhorn List backup volumes. Self-contained
    Naftiko capability covering one Longhorn business surface.'
  tags:
  - Longhorn
  - Backups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LONGHORN_API_KEY: LONGHORN_API_KEY
capability:
  consumes:
  - type: http
    namespace: manager-backups
    baseUri: http://{longhornManagerHost}:{longhornManagerPort}
    description: Longhorn Manager API — Backups business capability. Self-contained, no shared references.
    resources:
    - name: v1-backupvolumes
      path: /v1/backupvolumes
      operations:
      - name: listbackupvolumes
        method: GET
        description: Longhorn List backup volumes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-backupvolumes-backupVolumeName
      path: /v1/backupvolumes/{backupVolumeName}
      operations:
      - name: getbackupvolume
        method: GET
        description: Longhorn Get a backup volume
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-backupvolumes-backupVolumeName-backups
      path: /v1/backupvolumes/{backupVolumeName}/backups
      operations:
      - name: listbackups
        method: GET
        description: Longhorn List backups for a backup volume
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-volumes-volumeName}?action=snapshotBackup
      path: /v1/volumes/{volumeName}?action=snapshotBackup
      operations:
      - name: backupsnapshot
        method: POST
        description: Longhorn Back up a snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.LONGHORN_API_KEY}}'
  exposes:
  - type: rest
    namespace: manager-backups-rest
    port: 8080
    description: REST adapter for Longhorn Manager API — Backups. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/backupvolumes
      name: v1-backupvolumes
      description: REST surface for v1-backupvolumes.
      operations:
      - method: GET
        name: listbackupvolumes
        description: Longhorn List backup volumes
        call: manager-backups.listbackupvolumes
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/backupvolumes/{backupvolumename}
      name: v1-backupvolumes-backupvolumename
      description: REST surface for v1-backupvolumes-backupVolumeName.
      operations:
      - method: GET
        name: getbackupvolume
        description: Longhorn Get a backup volume
        call: manager-backups.getbackupvolume
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/backupvolumes/{backupvolumename}/backups
      name: v1-backupvolumes-backupvolumename-backups
      description: REST surface for v1-backupvolumes-backupVolumeName-backups.
      operations:
      - method: GET
        name: listbackups
        description: Longhorn List backups for a backup volume
        call: manager-backups.listbackups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/volumes/volumename-action-snapshotbackup
      name: v1-volumes-volumename-action-snapshotbackup
      description: REST surface for v1-volumes-volumeName}?action=snapshotBackup.
      operations:
      - method: POST
        name: backupsnapshot
        description: Longhorn Back up a snapshot
        call: manager-backups.backupsnapshot
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: manager-backups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Longhorn Manager API — Backups. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: longhorn-list-backup-volumes
      description: Longhorn List backup volumes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: manager-backups.listbackupvolumes
      outputParameters:
      - type: object
        mapping: $.
    - name: longhorn-get-backup-volume
      description: Longhorn Get a backup volume
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: manager-backups.getbackupvolume
      outputParameters:
      - type: object
        mapping: $.
    - name: longhorn-list-backups-backup-volume
      description: Longhorn List backups for a backup volume
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: manager-backups.listbackups
      outputParameters:
      - type: object
        mapping: $.
    - name: longhorn-back-up-snapshot
      description: Longhorn Back up a snapshot
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: manager-backups.backupsnapshot
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.