Trellix Web Gateway Policy API — URL Filtering

naftiko: 1.0.0-alpha2
info:
  label: Trellix Web Gateway Policy API — URL Filtering
  description: 'Trellix Web Gateway Policy API — URL Filtering. 4 operations. Lead operation: List URL categories. Self-contained
    Naftiko capability covering one Trellix Web Gateway business surface.'
  tags:
  - Trellix Web Gateway
  - URL Filtering
  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-url-filtering
    baseUri: https://{mwg-server}:{port}/Konfigurator/REST/policy
    description: Trellix Web Gateway Policy API — URL Filtering business capability. Self-contained, no shared references.
    resources:
    - name: urlfilter-categories
      path: /urlfilter/categories
      operations:
      - name: listurlcategories
        method: GET
        description: List URL categories
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: urlfilter-lookup
      path: /urlfilter/lookup
      operations:
      - name: lookupurl
        method: GET
        description: Look up URL categorization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: url
          in: query
          type: string
          description: URL to look up
          required: true
    - name: urlfilter-settings
      path: /urlfilter/settings
      operations:
      - name: geturlfiltersettings
        method: GET
        description: Get URL filter settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateurlfiltersettings
        method: PUT
        description: Update URL filter settings
        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: JSESSIONID
      value: '{{env.TRELLIX_WEB_GATEWAY_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: policy-url-filtering-rest
    port: 8080
    description: REST adapter for Trellix Web Gateway Policy API — URL Filtering. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/urlfilter/categories
      name: urlfilter-categories
      description: REST surface for urlfilter-categories.
      operations:
      - method: GET
        name: listurlcategories
        description: List URL categories
        call: policy-url-filtering.listurlcategories
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/urlfilter/lookup
      name: urlfilter-lookup
      description: REST surface for urlfilter-lookup.
      operations:
      - method: GET
        name: lookupurl
        description: Look up URL categorization
        call: policy-url-filtering.lookupurl
        with:
          url: rest.url
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/urlfilter/settings
      name: urlfilter-settings
      description: REST surface for urlfilter-settings.
      operations:
      - method: GET
        name: geturlfiltersettings
        description: Get URL filter settings
        call: policy-url-filtering.geturlfiltersettings
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateurlfiltersettings
        description: Update URL filter settings
        call: policy-url-filtering.updateurlfiltersettings
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: policy-url-filtering-mcp
    port: 9090
    transport: http
    description: MCP adapter for Trellix Web Gateway Policy API — URL Filtering. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-url-categories
      description: List URL categories
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: policy-url-filtering.listurlcategories
      outputParameters:
      - type: object
        mapping: $.
    - name: look-up-url-categorization
      description: Look up URL categorization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: policy-url-filtering.lookupurl
      with:
        url: tools.url
      outputParameters:
      - type: object
        mapping: $.
    - name: get-url-filter-settings
      description: Get URL filter settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: policy-url-filtering.geturlfiltersettings
      outputParameters:
      - type: object
        mapping: $.
    - name: update-url-filter-settings
      description: Update URL filter settings
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: policy-url-filtering.updateurlfiltersettings
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.