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.

Client profile

Prev Next

The client profile APIs used from shell on the appliance:

GET http://localhost:8085/config/v1/clientprofile
POSThttp://localhost:8085/config/v1/clientprofile 
http://localhost:8085/config/v1/clientprofile /{profile-name} PUT
http://localhost:8085/config/v1/clientprofile /{profile-name} DELETE

The client profile APIs used from remote host:    

 GET https://IA_IP_Address/config/v1/clientprofile 
 POST [https://IA_IP)Address/config/v1/clientprofile]https://IA_IP)Address/config/v1/clientprofile 
  PUT https://IA_IP_Address/config/v1/clientprofile/(profile-name)
 GET https://IA_IP_Address/config/v1/clientprofile 

Examples

curl -k -u npadmin:Fireeye@123 -XGET https://IA_IP_Address/config/v1/clientprofile
Response:
[
    {
        "name": " test_client_profile ",
        "id": "aea994b4",
        "l7_metadata": {
            "enabled": true,
            "protocols": [
                "DNS",
                "MODBUS"
            ]
        },
        "alerts": {
            "enabled": true,
            "alert_severity_threshold": "Low"
        },
        "hash": "a6113fafd98d02c84dd582d1d0037eb2"
    }
]
 curl -k -u npadmin:Fireeye@123 https://IA_IP_Address/config/v1/clientprofile/profile1 -XDELETE 
curl -k -u npadmin:Fireeye@123 https://IA_IP_Address/config/v1/clientprofile -XPOST --data @profile.json
  json format -> {"name":"profilename","id":"","l7_metadata":{"enabled":true,"protocols":[]},"alerts":{"enabled":true,"alert_severity_threshold":"Low"},"hash":""}

where:

  • Name—Name of client profile to be created.

  • ID— ID of client profile. (This field must be left blank in JSON)

  • Protocols—Protocols to be enabled.

  • Hash—Hash is assigned after the client profile is created. (This field must be left blank in JSON)

Examples of JSON fFile

{
        "name": "test_client_profile",
        "id": "",
        "l7_metadata": {
            "enabled": true,
            "protocols": [
                "SIP",
                "HTTP",
                "DNS",
                "RTSP",
                "TACPLUS",
                "FILEINFO",
                "SMB",
                "MODBUS",
                "WEBSOCKET",
            ]
 },
        "alerts": {
            "enabled": true,
            "alert_severity_threshold": "High"
        },
        "hash": ""
    }