Trellix Web Gateway Policy API — Rule Sets

naftiko: 1.0.0-alpha2
info:
  label: Trellix Web Gateway Policy API — Rule Sets
  description: 'Trellix Web Gateway Policy API — Rule Sets. 7 operations. Lead operation: List all rule sets. Self-contained
    Naftiko capability covering one Trellix Web Gateway business surface.'
  tags:
  - Trellix Web Gateway
  - Rule Sets
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TRELLIX_WEB_GATEWAY_API_KEY: TRELLIX_WEB_GATEWAY_API_KEY
capability:
  consumes:
  - type: http
    namespace: policy-rule-sets
    baseUri: https://{mwg-server}:{port}/Konfigurator/REST/policy
    description: Trellix Web Gateway Policy API — Rule Sets business capability. Self-contained, no shared references.
    resources:
    - name: rulesets
      path: /rulesets
      operations:
      - name: listrulesets
        method: GET
        description: List all rule sets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: query
          type: string
          description: Filter by rule set type
        - name: enabled
          in: query
          type: boolean
          description: Filter by enabled status
      - name: createruleset
        method: POST
        description: Create a new rule set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rulesets-ruleSetId
      path: /rulesets/{ruleSetId}
      operations:
      - name: getruleset
        method: GET
        description: Get a rule set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateruleset
        method: PUT
        description: Update a rule set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteruleset
        method: DELETE
        description: Delete a rule set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rulesets-ruleSetId-disable
      path: /rulesets/{ruleSetId}/disable
      operations:
      - name: disableruleset
        method: POST
        description: Disable a rule set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rulesets-ruleSetId-enable
      path: /rulesets/{ruleSetId}/enable
      operations:
      - name: enableruleset
        method: POST
        description: Enable a rule set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: JSESSIONID
      value: '{{env.TRELLIX_WEB_GATEWAY_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: policy-rule-sets-rest
    port: 8080
    description: REST adapter for Trellix Web Gateway Policy API — Rule Sets. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/rulesets
      name: rulesets
      description: REST surface for rulesets.
      operations:
      - method: GET
        name: listrulesets
        description: List all rule sets
        call: policy-rule-sets.listrulesets
        with:
          type: rest.type
          enabled: rest.enabled
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createruleset
        description: Create a new rule set
        call: policy-rule-sets.createruleset
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/rulesets/{rulesetid}
      name: rulesets-rulesetid
      description: REST surface for rulesets-ruleSetId.
      operations:
      - method: GET
        name: getruleset
        description: Get a rule set
        call: policy-rule-sets.getruleset
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateruleset
        description: Update a rule set
        call: policy-rule-sets.updateruleset
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteruleset
        description: Delete a rule set
        call: policy-rule-sets.deleteruleset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/rulesets/{rulesetid}/disable
      name: rulesets-rulesetid-disable
      description: REST surface for rulesets-ruleSetId-disable.
      operations:
      - method: POST
        name: disableruleset
        description: Disable a rule set
        call: policy-rule-sets.disableruleset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/rulesets/{rulesetid}/enable
      name: rulesets-rulesetid-enable
      description: REST surface for rulesets-ruleSetId-enable.
      operations:
      - method: POST
        name: enableruleset
        description: Enable a rule set
        call: policy-rule-sets.enableruleset
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: policy-rule-sets-mcp
    port: 9090
    transport: http
    description: MCP adapter for Trellix Web Gateway Policy API — Rule Sets. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-all-rule-sets
      description: List all rule sets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: policy-rule-sets.listrulesets
      with:
        type: tools.type
        enabled: tools.enabled
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-rule-set
      description: Create a new rule set
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: policy-rule-sets.createruleset
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-rule-set
      description: Get a rule set
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: policy-rule-sets.getruleset
      outputParameters:
      - type: object
        mapping: $.
    - name: update-rule-set
      description: Update a rule set
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: policy-rule-sets.updateruleset
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-rule-set
      description: Delete a rule set
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: policy-rule-sets.deleteruleset
      outputParameters:
      - type: object
        mapping: $.
    - name: disable-rule-set
      description: Disable a rule set
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: policy-rule-sets.disableruleset
      outputParameters:
      - type: object
        mapping: $.
    - name: enable-rule-set
      description: Enable a rule set
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: policy-rule-sets.enableruleset
      outputParameters:
      - type: object
        mapping: $.