Trellix Web Gateway Data Loss Prevention API

openapi: 3.1.0
info:
  title: Trellix Web Gateway Policy Anti-Malware Data Loss Prevention 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: Data Loss Prevention
  description: DLP policy configuration
paths:
  /dlp/settings:
    get:
      operationId: getDlpSettings
      summary: Get DLP settings
      description: Retrieve the current Data Loss Prevention configuration including enabled classifiers, actions, and sensitivity levels.
      tags:
      - Data Loss Prevention
      responses:
        '200':
          description: DLP settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DlpSettings'
        '401':
          description: Unauthorized
    put:
      operationId: updateDlpSettings
      summary: Update DLP settings
      description: Update the Data Loss Prevention configuration. Changes must be committed to take effect.
      tags:
      - Data Loss Prevention
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DlpSettings'
      responses:
        '200':
          description: Settings updated
        '400':
          description: Invalid settings
        '401':
          description: Unauthorized
  /dlp/classifiers:
    get:
      operationId: listDlpClassifiers
      summary: List DLP classifiers
      description: Retrieve the list of available data classifiers for content inspection and data loss prevention.
      tags:
      - Data Loss Prevention
      responses:
        '200':
          description: List of DLP classifiers
          content:
            application/json:
              schema:
                type: object
                properties:
                  classifiers:
                    type: array
                    items:
                      $ref: '#/components/schemas/DlpClassifier'
        '401':
          description: Unauthorized
components:
  schemas:
    DlpClassifier:
      type: object
      properties:
        id:
          type: string
          description: Classifier identifier
        name:
          type: string
          description: Classifier name
        description:
          type: string
          description: What the classifier detects
        type:
          type: string
          enum:
          - builtin
          - custom
          - regex
          description: Classifier type
        enabled:
          type: boolean
          description: Whether the classifier is active
    DlpSettings:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether DLP is enabled
        action:
          type: string
          enum:
          - block
          - log
          - quarantine
          description: Default action when sensitive data is detected
        enabledClassifiers:
          type: array
          items:
            type: string
          description: List of enabled classifier IDs
        scanUploads:
          type: boolean
          description: Whether to scan file uploads
        scanFormData:
          type: boolean
          description: Whether to scan form data submissions
  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