API Reference — ConfigService

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