Couchbase Backup Service REST API — Data

naftiko: 1.0.0-alpha2
info:
  label: Couchbase Backup Service REST API — Data
  description: 'Couchbase Backup Service REST API — Data. 2 operations. Lead operation: Trigger an immediate backup. Self-contained
    Naftiko capability covering one Couchbase business surface.'
  tags:
  - Couchbase
  - Data
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COUCHBASE_API_KEY: COUCHBASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: backup-service-rest-data
    baseUri: https://localhost:8097
    description: Couchbase Backup Service REST API — Data business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-cluster-self-repository-active-repositoryId-backup
      path: /api/v1/cluster/self/repository/active/{repositoryId}/backup
      operations:
      - name: triggerimmediatebackup
        method: POST
        description: Trigger an immediate backup
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v1-cluster-self-repository-active-repositoryId-restore
      path: /api/v1/cluster/self/repository/active/{repositoryId}/restore
      operations:
      - name: restorefrombackup
        method: POST
        description: Restore from a backup
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.COUCHBASE_USER}}'
      password: '{{env.COUCHBASE_PASS}}'
  exposes:
  - type: rest
    namespace: backup-service-rest-data-rest
    port: 8080
    description: REST adapter for Couchbase Backup Service REST API — Data. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/cluster/self/repository/active/{repositoryid}/backup
      name: api-v1-cluster-self-repository-active-repositoryid-backup
      description: REST surface for api-v1-cluster-self-repository-active-repositoryId-backup.
      operations:
      - method: POST
        name: triggerimmediatebackup
        description: Trigger an immediate backup
        call: backup-service-rest-data.triggerimmediatebackup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/cluster/self/repository/active/{repositoryid}/restore
      name: api-v1-cluster-self-repository-active-repositoryid-restore
      description: REST surface for api-v1-cluster-self-repository-active-repositoryId-restore.
      operations:
      - method: POST
        name: restorefrombackup
        description: Restore from a backup
        call: backup-service-rest-data.restorefrombackup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: backup-service-rest-data-mcp
    port: 9090
    transport: http
    description: MCP adapter for Couchbase Backup Service REST API — Data. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: trigger-immediate-backup
      description: Trigger an immediate backup
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: backup-service-rest-data.triggerimmediatebackup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: restore-backup
      description: Restore from a backup
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: backup-service-rest-data.restorefrombackup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.