API custom configuration channels allow you to manually supply agent configuration file settings to multiple hosts included in one or more host sets. Using the API, you can create, modify, and delete custom configuration channels. You can also use the API to review the channel definitions and to obtain a list of the agent settings for a specific host.
Configuration file settings applied using an API custom configuration channel replace all existing agent configuration settings. If any configuration file settings are not specified in a custom configuration channel, the default values for the Trellix Endpoint Security (HX) xAgent settings are used. See the Agent Configuration File Reference for all default values.
The agent default values are not necessarily the same as the Web UI default values for the same configuration options. Any changes you make to these values in the Web UI are ignored by the values applied after you use an API custom configuration channel to change the agent settings.
The only exceptions to this are the values for the credentials and serverlist sections of the configuration file and the following individual configuration settings: channel, id, name, ts, type, and version. The values for these configuration file settings cannot be specified using custom configuration channels and any attempts to do so will be overridden by the Endpoint Security (HX) API with values established during initial Endpoint Security (HX) server and agent deployment.
Important
Trellix recommends that you provide settings for every configuration file setting when you create an API custom configuration channel. If you do not provide a value for an agent configuration file setting, the agent default values are used.
api_admin authorization for the API
Custom configuration channels can only be specified for hosts running Endpoint Security (HX) xAgent software version 20 or greater.
Any hosts running versions earlier than version 20 that are included in the host sets of a custom configuration channel are ignored.
You must have one or more host sets defined in the Web UI that identify the host endpoints to which you want the new configuration settings applied. For information about managing host sets, see the Endpoint Security (HX) Server User Guide.
In addition, you must know the IDs for the host sets before you create a custom configuration channel that will include them. Host set IDs can be identified using the API. See Identifying Host Set IDs Using the API .
The following sections describe custom configuration channel behavior and how to create and delete a custom configuration channel request. For information on API custom configuration channel endpoints, see the Endpoint Security (HX) REST API Guide.