API Reference — SensorUpgradeService

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