API Reference — ClustersService

naftiko: 1.0.0-alpha2
info:
  label: API Reference — ClustersService
  description: 'API Reference — ClustersService. 5 operations. Lead operation: ClustersService. Self-contained Naftiko capability
    covering one Stackrox business surface.'
  tags:
  - Stackrox
  - ClustersService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKROX_API_KEY: STACKROX_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackrox-clustersservice
    baseUri: https://{central-host}
    description: API Reference — ClustersService business capability. Self-contained, no shared references.
    resources:
    - name: v1-clusters
      path: /v1/clusters
      operations:
      - name: getclusters
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
      - name: postcluster
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-clusters-id
      path: /v1/clusters/{id}
      operations:
      - name: getcluster
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: deletecluster
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: putcluster
        method: PUT
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STACKROX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: stackrox-clustersservice-rest
    port: 8080
    description: REST adapter for API Reference — ClustersService. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/clusters
      name: v1-clusters
      description: REST surface for v1-clusters.
      operations:
      - method: GET
        name: getclusters
        description: getclusters
        call: stackrox-clustersservice.getclusters
        with:
          query: rest.query
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postcluster
        description: postcluster
        call: stackrox-clustersservice.postcluster
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/clusters/{id}
      name: v1-clusters-id
      description: REST surface for v1-clusters-id.
      operations:
      - method: GET
        name: getcluster
        description: getcluster
        call: stackrox-clustersservice.getcluster
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecluster
        description: deletecluster
        call: stackrox-clustersservice.deletecluster
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putcluster
        description: putcluster
        call: stackrox-clustersservice.putcluster
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackrox-clustersservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — ClustersService. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: getclusters
      description: getclusters
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-clustersservice.getclusters
      with:
        query: tools.query
      outputParameters:
      - type: object
        mapping: $.
    - name: postcluster
      description: postcluster
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-clustersservice.postcluster
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: getcluster
      description: getcluster
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-clustersservice.getcluster
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: deletecluster
      description: deletecluster
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: stackrox-clustersservice.deletecluster
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: putcluster
      description: putcluster
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-clustersservice.putcluster
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.