Incus external REST API — cluster-groups

naftiko: 1.0.0-alpha2
info:
  label: Incus external REST API — cluster-groups
  description: 'Incus external REST API — cluster-groups. 7 operations. Lead operation: Get the cluster groups. Self-contained
    Naftiko capability covering one Incus business surface.'
  tags:
  - Incus
  - cluster-groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    INCUS_API_KEY: INCUS_API_KEY
capability:
  consumes:
  - type: http
    namespace: incus-cluster-groups
    baseUri: ''
    description: Incus external REST API — cluster-groups business capability. Self-contained, no shared references.
    resources:
    - name: 1.0-cluster-groups
      path: /1.0/cluster/groups
      operations:
      - name: clustergroupsget
        method: GET
        description: Get the cluster groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: 1.0-cluster-groups-name
      path: /1.0/cluster/groups/{name}
      operations:
      - name: clustergroupdelete
        method: DELETE
        description: Delete the cluster group.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Cluster group name
          required: true
      - name: clustergroupget
        method: GET
        description: Get the cluster group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Cluster group name
          required: true
      - name: clustergrouppatch
        method: PATCH
        description: Update the cluster group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Cluster group name
          required: true
        - name: cluster group
          in: body
          type: string
          description: cluster group configuration
          required: true
      - name: clustergrouppost
        method: POST
        description: Rename the cluster group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Cluster group name
          required: true
        - name: name
          in: body
          type: string
          description: Cluster group rename request
          required: true
      - name: clustergroupput
        method: PUT
        description: Update the cluster group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Cluster group name
          required: true
        - name: cluster group
          in: body
          type: string
          description: cluster group configuration
          required: true
    - name: 1.0-cluster-groups?recursion=1
      path: /1.0/cluster/groups?recursion=1
      operations:
      - name: clustergroupsgetrecursion1
        method: GET
        description: Get the cluster groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: incus-cluster-groups-rest
    port: 8080
    description: REST adapter for Incus external REST API — cluster-groups. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/1-0/cluster/groups
      name: 1-0-cluster-groups
      description: REST surface for 1.0-cluster-groups.
      operations:
      - method: GET
        name: clustergroupsget
        description: Get the cluster groups
        call: incus-cluster-groups.clustergroupsget
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/1-0/cluster/groups/{name}
      name: 1-0-cluster-groups-name
      description: REST surface for 1.0-cluster-groups-name.
      operations:
      - method: DELETE
        name: clustergroupdelete
        description: Delete the cluster group.
        call: incus-cluster-groups.clustergroupdelete
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: clustergroupget
        description: Get the cluster group
        call: incus-cluster-groups.clustergroupget
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: clustergrouppatch
        description: Update the cluster group
        call: incus-cluster-groups.clustergrouppatch
        with:
          name: rest.name
          cluster group: rest.cluster group
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: clustergrouppost
        description: Rename the cluster group
        call: incus-cluster-groups.clustergrouppost
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: clustergroupput
        description: Update the cluster group
        call: incus-cluster-groups.clustergroupput
        with:
          name: rest.name
          cluster group: rest.cluster group
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/1-0/cluster/groups-recursion-1
      name: 1-0-cluster-groups-recursion-1
      description: REST surface for 1.0-cluster-groups?recursion=1.
      operations:
      - method: GET
        name: clustergroupsgetrecursion1
        description: Get the cluster groups
        call: incus-cluster-groups.clustergroupsgetrecursion1
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: incus-cluster-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Incus external REST API — cluster-groups. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-cluster-groups
      description: Get the cluster groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: incus-cluster-groups.clustergroupsget
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-cluster-group
      description: Delete the cluster group.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: incus-cluster-groups.clustergroupdelete
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: get-cluster-group
      description: Get the cluster group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: incus-cluster-groups.clustergroupget
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: update-cluster-group
      description: Update the cluster group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: incus-cluster-groups.clustergrouppatch
      with:
        name: tools.name
        cluster group: tools.cluster group
      outputParameters:
      - type: object
        mapping: $.
    - name: rename-cluster-group
      description: Rename the cluster group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: incus-cluster-groups.clustergrouppost
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: update-cluster-group-2
      description: Update the cluster group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: incus-cluster-groups.clustergroupput
      with:
        name: tools.name
        cluster group: tools.cluster group
      outputParameters:
      - type: object
        mapping: $.
    - name: get-cluster-groups-2
      description: Get the cluster groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: incus-cluster-groups.clustergroupsgetrecursion1
      outputParameters:
      - type: object
        mapping: $.