Trellix Web Gateway REST API — System

naftiko: 1.0.0-alpha2
info:
  label: Trellix Web Gateway REST API — System
  description: 'Trellix Web Gateway REST API — System. 3 operations. Lead operation: Get system information. Self-contained
    Naftiko capability covering one Trellix Web Gateway business surface.'
  tags:
  - Trellix Web Gateway
  - System
  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-system
    baseUri: https://{mwg-server}:{port}/Konfigurator/REST
    description: Trellix Web Gateway REST API — System business capability. Self-contained, no shared references.
    resources:
    - name: system
      path: /system
      operations:
      - name: getsysteminfo
        method: GET
        description: Get system information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: system-appliances
      path: /system/appliances
      operations:
      - name: listappliances
        method: GET
        description: List managed appliances
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: system-appliances-applianceId
      path: /system/appliances/{applianceId}
      operations:
      - name: getappliance
        method: GET
        description: Get appliance details
        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-system-rest
    port: 8080
    description: REST adapter for Trellix Web Gateway REST API — System. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/system
      name: system
      description: REST surface for system.
      operations:
      - method: GET
        name: getsysteminfo
        description: Get system information
        call: rest-system.getsysteminfo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/system/appliances
      name: system-appliances
      description: REST surface for system-appliances.
      operations:
      - method: GET
        name: listappliances
        description: List managed appliances
        call: rest-system.listappliances
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/system/appliances/{applianceid}
      name: system-appliances-applianceid
      description: REST surface for system-appliances-applianceId.
      operations:
      - method: GET
        name: getappliance
        description: Get appliance details
        call: rest-system.getappliance
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-system-mcp
    port: 9090
    transport: http
    description: MCP adapter for Trellix Web Gateway REST API — System. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-system-information
      description: Get system information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-system.getsysteminfo
      outputParameters:
      - type: object
        mapping: $.
    - name: list-managed-appliances
      description: List managed appliances
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-system.listappliances
      outputParameters:
      - type: object
        mapping: $.
    - name: get-appliance-details
      description: Get appliance details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-system.getappliance
      outputParameters:
      - type: object
        mapping: $.