VMware vSphere Automation REST API — Clusters

naftiko: 1.0.0-alpha2
info:
  label: VMware vSphere Automation REST API — Clusters
  description: 'VMware vSphere Automation REST API — Clusters. 2 operations. Lead operation: Vmware List Clusters. Self-contained
    Naftiko capability covering one Vmware business surface.'
  tags:
  - Vmware
  - Clusters
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VMWARE_API_KEY: VMWARE_API_KEY
capability:
  consumes:
  - type: http
    namespace: vsphere-clusters
    baseUri: https://{vcenter}/api
    description: VMware vSphere Automation REST API — Clusters business capability. Self-contained, no shared references.
    resources:
    - name: vcenter-cluster
      path: /vcenter/cluster
      operations:
      - name: listclusters
        method: GET
        description: Vmware List Clusters
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter.clusters
          in: query
          type: array
          description: Identifiers of clusters to filter by
        - name: filter.names
          in: query
          type: array
          description: Names of clusters to filter by
        - name: filter.folders
          in: query
          type: array
          description: Folders that must contain the clusters
        - name: filter.datacenters
          in: query
          type: array
          description: Datacenters that must contain the clusters
    - name: vcenter-cluster-cluster
      path: /vcenter/cluster/{cluster}
      operations:
      - name: getcluster
        method: GET
        description: Vmware Get Cluster Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: vmware-api-session-id
      value: '{{env.VMWARE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: vsphere-clusters-rest
    port: 8080
    description: REST adapter for VMware vSphere Automation REST API — Clusters. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/vcenter/cluster
      name: vcenter-cluster
      description: REST surface for vcenter-cluster.
      operations:
      - method: GET
        name: listclusters
        description: Vmware List Clusters
        call: vsphere-clusters.listclusters
        with:
          filter.clusters: rest.filter.clusters
          filter.names: rest.filter.names
          filter.folders: rest.filter.folders
          filter.datacenters: rest.filter.datacenters
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/vcenter/cluster/{cluster}
      name: vcenter-cluster-cluster
      description: REST surface for vcenter-cluster-cluster.
      operations:
      - method: GET
        name: getcluster
        description: Vmware Get Cluster Details
        call: vsphere-clusters.getcluster
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: vsphere-clusters-mcp
    port: 9090
    transport: http
    description: MCP adapter for VMware vSphere Automation REST API — Clusters. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: vmware-list-clusters
      description: Vmware List Clusters
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vsphere-clusters.listclusters
      with:
        filter.clusters: tools.filter.clusters
        filter.names: tools.filter.names
        filter.folders: tools.filter.folders
        filter.datacenters: tools.filter.datacenters
      outputParameters:
      - type: object
        mapping: $.
    - name: vmware-get-cluster-details
      description: Vmware Get Cluster Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vsphere-clusters.getcluster
      outputParameters:
      - type: object
        mapping: $.