Couchbase · Capability

Couchbase Backup Service REST API — Cluster

Couchbase Backup Service REST API — Cluster. 1 operations. Lead operation: Get backup cluster information. Self-contained Naftiko capability covering one Couchbase business surface.

Run with Naftiko CouchbaseCluster

What You Can Do

GET
Getbackupclusterinfo — Get backup cluster information
/v1/api/v1/cluster/self

MCP Tools

get-backup-cluster-information

Get backup cluster information

read-only idempotent

Capability Spec

backup-service-rest-cluster.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Couchbase Backup Service REST API — Cluster
  description: 'Couchbase Backup Service REST API — Cluster. 1 operations. Lead operation: Get backup cluster information.
    Self-contained Naftiko capability covering one Couchbase business surface.'
  tags:
  - Couchbase
  - Cluster
  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-cluster
    baseUri: https://localhost:8097
    description: Couchbase Backup Service REST API — Cluster business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-cluster-self
      path: /api/v1/cluster/self
      operations:
      - name: getbackupclusterinfo
        method: GET
        description: Get backup cluster information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.COUCHBASE_USER}}'
      password: '{{env.COUCHBASE_PASS}}'
  exposes:
  - type: rest
    namespace: backup-service-rest-cluster-rest
    port: 8080
    description: REST adapter for Couchbase Backup Service REST API — Cluster. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/v1/cluster/self
      name: api-v1-cluster-self
      description: REST surface for api-v1-cluster-self.
      operations:
      - method: GET
        name: getbackupclusterinfo
        description: Get backup cluster information
        call: backup-service-rest-cluster.getbackupclusterinfo
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: backup-service-rest-cluster-mcp
    port: 9090
    transport: http
    description: MCP adapter for Couchbase Backup Service REST API — Cluster. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-backup-cluster-information
      description: Get backup cluster information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: backup-service-rest-cluster.getbackupclusterinfo
      outputParameters:
      - type: object
        mapping: $.