The new docs.trellix.com features a modernized UI and AI-powered conversational search. Content is currently available in English, with additional languages launching in early November 2026. We hope you enjoy the updated experience.

Enabling the web services API

Prev Next

To enable the Web Services API on an integrated appliance:

  1. In a terminal window, log in to the command-line interface (CLI) on the appliance where you will run the Web Services API.

  2. Enable the CLI configuration mode:

    hostname > enable
    hostname # configure terminal
  3. Enable the Web Services API:

    hostname (config) # wsapi enable
  4. Verify that the Web Services API is enabled.

    For example, if you run the show wsapi command on the following appliances:

    Trellix Malware Analysis 8400:

    hostname (config) # show wsapi
       Server Enabled                                   :         yes
       Current State                                    :         running
       Max Alerts                                       :         200
       Max Submission Hour Threshold                    :         667
       Max Submission Day Threshold                     :         16000
       Max Minute API (including Submission) Threshold  :         1000
       Max Day API (including Submission) Threshold     :         100000			
    

    Trellix Central Management System 4400:

    hostname (config) # show wsapi
    wsapi status:
       Server Enabled                                   :         yes
       Current State                                    :         running
       Max Alerts                                       :         200
       Max Minute Threshold  			    :         1000
       Max Day Threshold     			    :         1000000
       OS Changes				            :         no
    

If the Web Services API is enabled, the Server Enabled status is set to yes.

  • Network Security appliance

    1. Enable the CLI configuration mode:

      hostname > enable hostname # configure terminal

    2. Enter the following command on the CMS:

      hostname (config) # cmc execute group sysgroup.Web_MPS command "wsapi enable"

  • Email Security — Server appliance

    1. Enable the CLI configuration mode:

      hostname > enable hostname # configure terminal

    2. Enter the following command on the Central Management System CLI:

      hostname (config) # cmc execute group sysgroup.Email_MPS command "wsapi enable"