Trellix Web Gateway Policy API — Rules

naftiko: 1.0.0-alpha2
info:
  label: Trellix Web Gateway Policy API — Rules
  description: 'Trellix Web Gateway Policy API — Rules. 5 operations. Lead operation: List rules in a rule set. Self-contained
    Naftiko capability covering one Trellix Web Gateway business surface.'
  tags:
  - Trellix Web Gateway
  - Rules
  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-rules
    baseUri: https://{mwg-server}:{port}/Konfigurator/REST/policy
    description: Trellix Web Gateway Policy API — Rules business capability. Self-contained, no shared references.
    resources:
    - name: rulesets-ruleSetId-rules
      path: /rulesets/{ruleSetId}/rules
      operations:
      - name: listrules
        method: GET
        description: List rules in a rule set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createrule
        method: POST
        description: Create a new rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rulesets-ruleSetId-rules-ruleId
      path: /rulesets/{ruleSetId}/rules/{ruleId}
      operations:
      - name: getrule
        method: GET
        description: Get a specific rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updaterule
        method: PUT
        description: Update a rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleterule
        method: DELETE
        description: Delete a rule
        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-rules-rest
    port: 8080
    description: REST adapter for Trellix Web Gateway Policy API — Rules. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/rulesets/{rulesetid}/rules
      name: rulesets-rulesetid-rules
      description: REST surface for rulesets-ruleSetId-rules.
      operations:
      - method: GET
        name: listrules
        description: List rules in a rule set
        call: policy-rules.listrules
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createrule
        description: Create a new rule
        call: policy-rules.createrule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/rulesets/{rulesetid}/rules/{ruleid}
      name: rulesets-rulesetid-rules-ruleid
      description: REST surface for rulesets-ruleSetId-rules-ruleId.
      operations:
      - method: GET
        name: getrule
        description: Get a specific rule
        call: policy-rules.getrule
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updaterule
        description: Update a rule
        call: policy-rules.updaterule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterule
        description: Delete a rule
        call: policy-rules.deleterule
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: policy-rules-mcp
    port: 9090
    transport: http
    description: MCP adapter for Trellix Web Gateway Policy API — Rules. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-rules-rule-set
      description: List rules in a rule set
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: policy-rules.listrules
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-rule
      description: Create a new rule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: policy-rules.createrule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-specific-rule
      description: Get a specific rule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: policy-rules.getrule
      outputParameters:
      - type: object
        mapping: $.
    - name: update-rule
      description: Update a rule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: policy-rules.updaterule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-rule
      description: Delete a rule
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: policy-rules.deleterule
      outputParameters:
      - type: object
        mapping: $.