Trellix Web Gateway Troubleshooting API

openapi: 3.1.0
info:
  title: Trellix Web Gateway Policy Anti-Malware Troubleshooting API
  description: API for creating, updating, and managing security policies, rule sets, and configurations for web filtering and threat prevention on Trellix Web Gateway (formerly McAfee Web Gateway). Provides programmatic access to policy rules, URL filter settings, anti-malware settings, and SSL scanning configurations.
  version: '1.0'
  contact:
    name: Trellix Support
    url: https://www.trellix.com/support/
    email: support@trellix.com
  termsOfService: https://www.trellix.com/legal/terms-of-use/
servers:
- url: https://{mwg-server}:{port}/Konfigurator/REST/policy
  description: Trellix Web Gateway Policy Endpoint
  variables:
    mwg-server:
      default: mwg.example.com
      description: Hostname or IP address of the Web Gateway appliance
    port:
      default: '4712'
      description: Management port for the REST API
security:
- cookieAuth: []
tags:
- name: Troubleshooting
  description: Log access and diagnostic operations
paths:
  /troubleshooting/logs:
    get:
      operationId: getLogs
      summary: Retrieve system logs
      description: Access system and audit logs from the Web Gateway appliance for troubleshooting and monitoring purposes.
      tags:
      - Troubleshooting
      parameters:
      - name: type
        in: query
        description: Type of log to retrieve
        schema:
          type: string
          enum:
          - system
          - audit
          - access
          - debug
      - name: from
        in: query
        description: Start timestamp for log retrieval
        schema:
          type: string
          format: date-time
      - name: to
        in: query
        description: End timestamp for log retrieval
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        description: Maximum number of log entries to return
        schema:
          type: integer
          default: 100
      responses:
        '200':
          description: Log entries returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  entries:
                    type: array
                    items:
                      $ref: '#/components/schemas/LogEntry'
        '401':
          description: Unauthorized
  /troubleshooting/feedback:
    get:
      operationId: getFeedbackFiles
      summary: List feedback files
      description: Retrieve the list of available feedback and diagnostic files generated by the appliance.
      tags:
      - Troubleshooting
      responses:
        '200':
          description: Feedback files listed
          content:
            application/json:
              schema:
                type: object
                properties:
                  files:
                    type: array
                    items:
                      $ref: '#/components/schemas/FileInfo'
        '401':
          description: Unauthorized
components:
  schemas:
    FileInfo:
      type: object
      properties:
        name:
          type: string
          description: File name
        size:
          type: integer
          description: File size in bytes
        lastModified:
          type: string
          format: date-time
          description: Last modification timestamp
        type:
          type: string
          description: File type or MIME type
    LogEntry:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          description: Log entry timestamp
        level:
          type: string
          enum:
          - DEBUG
          - INFO
          - WARNING
          - ERROR
          - CRITICAL
          description: Log severity level
        source:
          type: string
          description: Component that generated the log entry
        message:
          type: string
          description: Log message content
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: JSESSIONID
      description: Session cookie obtained via the Konfigurator REST /login endpoint.
externalDocs:
  description: Trellix Web Gateway Policy API Documentation
  url: https://docs.trellix.com/bundle/web-gateway-policy-api