Trellix Web Gateway REST API — Lists

naftiko: 1.0.0-alpha2
info:
  label: Trellix Web Gateway REST API — Lists
  description: 'Trellix Web Gateway REST API — Lists. 5 operations. Lead operation: List custom lists. Self-contained Naftiko
    capability covering one Trellix Web Gateway business surface.'
  tags:
  - Trellix Web Gateway
  - Lists
  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: rest-lists
    baseUri: https://{mwg-server}:{port}/Konfigurator/REST
    description: Trellix Web Gateway REST API — Lists business capability. Self-contained, no shared references.
    resources:
    - name: lists
      path: /lists
      operations:
      - name: listcustomlists
        method: GET
        description: List custom lists
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: lists-listId
      path: /lists/{listId}
      operations:
      - name: getcustomlist
        method: GET
        description: Get a custom list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecustomlist
        method: PUT
        description: Update a custom list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: lists-listId-entries
      path: /lists/{listId}/entries
      operations:
      - name: addlistentry
        method: POST
        description: Add an entry to a custom list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: lists-listId-entries-entryId
      path: /lists/{listId}/entries/{entryId}
      operations:
      - name: deletelistentry
        method: DELETE
        description: Delete an entry from a custom list
        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: rest-lists-rest
    port: 8080
    description: REST adapter for Trellix Web Gateway REST API — Lists. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/lists
      name: lists
      description: REST surface for lists.
      operations:
      - method: GET
        name: listcustomlists
        description: List custom lists
        call: rest-lists.listcustomlists
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/lists/{listid}
      name: lists-listid
      description: REST surface for lists-listId.
      operations:
      - method: GET
        name: getcustomlist
        description: Get a custom list
        call: rest-lists.getcustomlist
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecustomlist
        description: Update a custom list
        call: rest-lists.updatecustomlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/lists/{listid}/entries
      name: lists-listid-entries
      description: REST surface for lists-listId-entries.
      operations:
      - method: POST
        name: addlistentry
        description: Add an entry to a custom list
        call: rest-lists.addlistentry
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/lists/{listid}/entries/{entryid}
      name: lists-listid-entries-entryid
      description: REST surface for lists-listId-entries-entryId.
      operations:
      - method: DELETE
        name: deletelistentry
        description: Delete an entry from a custom list
        call: rest-lists.deletelistentry
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-lists-mcp
    port: 9090
    transport: http
    description: MCP adapter for Trellix Web Gateway REST API — Lists. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-custom-lists
      description: List custom lists
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-lists.listcustomlists
      outputParameters:
      - type: object
        mapping: $.
    - name: get-custom-list
      description: Get a custom list
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-lists.getcustomlist
      outputParameters:
      - type: object
        mapping: $.
    - name: update-custom-list
      description: Update a custom list
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-lists.updatecustomlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: add-entry-custom-list
      description: Add an entry to a custom list
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-lists.addlistentry
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-entry-custom-list
      description: Delete an entry from a custom list
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-lists.deletelistentry
      outputParameters:
      - type: object
        mapping: $.