API Reference — ProcessWhitelistService

naftiko: 1.0.0-alpha2
info:
  label: API Reference — ProcessWhitelistService
  description: 'API Reference — ProcessWhitelistService. 3 operations. Lead operation: AddToProcessWhitelists adds a list
    of process names to each of a list of process whitelists. Self-contained Naftiko capability covering one Stackrox business
    surface.'
  tags:
  - Stackrox
  - ProcessWhitelistService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKROX_API_KEY: STACKROX_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackrox-processwhitelistservice
    baseUri: https://{central-host}
    description: API Reference — ProcessWhitelistService business capability. Self-contained, no shared references.
    resources:
    - name: v1-processwhitelists
      path: /v1/processwhitelists
      operations:
      - name: updateprocesswhitelists
        method: PUT
        description: AddToProcessWhitelists adds a list of process names to each of a list of process whitelists
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-processwhitelists-key
      path: /v1/processwhitelists/key
      operations:
      - name: getprocesswhitelist
        method: GET
        description: GetProcessWhitelistById returns the single process whitelist referenced by the given ID.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key.deploymentId
          in: query
          type: string
          description: The idea is for the keys to be flexible.
        - name: key.containerName
          in: query
          type: string
        - name: key.clusterId
          in: query
          type: string
        - name: key.namespace
          in: query
          type: string
    - name: v1-processwhitelists-lock
      path: /v1/processwhitelists/lock
      operations:
      - name: lockprocesswhitelists
        method: PUT
        description: LockProcessWhitelists accepts a list of whitelist IDs, locks those whitelists, and returns the updated
          whitelist objects
        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-processwhitelistservice-rest
    port: 8080
    description: REST adapter for API Reference — ProcessWhitelistService. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/processwhitelists
      name: v1-processwhitelists
      description: REST surface for v1-processwhitelists.
      operations:
      - method: PUT
        name: updateprocesswhitelists
        description: AddToProcessWhitelists adds a list of process names to each of a list of process whitelists
        call: stackrox-processwhitelistservice.updateprocesswhitelists
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/processwhitelists/key
      name: v1-processwhitelists-key
      description: REST surface for v1-processwhitelists-key.
      operations:
      - method: GET
        name: getprocesswhitelist
        description: GetProcessWhitelistById returns the single process whitelist referenced by the given ID.
        call: stackrox-processwhitelistservice.getprocesswhitelist
        with:
          key.deploymentId: rest.key.deploymentId
          key.containerName: rest.key.containerName
          key.clusterId: rest.key.clusterId
          key.namespace: rest.key.namespace
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/processwhitelists/lock
      name: v1-processwhitelists-lock
      description: REST surface for v1-processwhitelists-lock.
      operations:
      - method: PUT
        name: lockprocesswhitelists
        description: LockProcessWhitelists accepts a list of whitelist IDs, locks those whitelists, and returns the updated
          whitelist objects
        call: stackrox-processwhitelistservice.lockprocesswhitelists
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackrox-processwhitelistservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — ProcessWhitelistService. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: addtoprocesswhitelists-adds-list-process-names
      description: AddToProcessWhitelists adds a list of process names to each of a list of process whitelists
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-processwhitelistservice.updateprocesswhitelists
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: getprocesswhitelistbyid-returns-single-process-whitelist
      description: GetProcessWhitelistById returns the single process whitelist referenced by the given ID.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-processwhitelistservice.getprocesswhitelist
      with:
        key.deploymentId: tools.key.deploymentId
        key.containerName: tools.key.containerName
        key.clusterId: tools.key.clusterId
        key.namespace: tools.key.namespace
      outputParameters:
      - type: object
        mapping: $.
    - name: lockprocesswhitelists-accepts-list-whitelist-ids
      description: LockProcessWhitelists accepts a list of whitelist IDs, locks those whitelists, and returns the updated
        whitelist objects
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-processwhitelistservice.lockprocesswhitelists
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.