Press CTRL+K to open search

Configuration information request

  • Published on Sep 3, 2026
  • 9 minute(s) read
Prev Next

If run on the Central Management System appliance, this request returns a list of guest image profiles and applications that are available on each appliance attached to the Central Management System appliance. This information may be used to submit malware objects for analysis.

If run on other appliances, this request returns a list of guest image profiles and applications that are available on the appliance that you use to run the Web Services API.

GET https://<address>/wsapis/{v1.2.0|v2.0.0}/config

Availability

This command is available on the following appliances:

  • Central Management System

  • Malware Analysis

  • Email Security — Server

  • File Protect

  • Network Security

Required headers:

X-FeApi-Token: [API-Token]
X-FeClient-Token: [Client-Token]

Parameters

  • address—The IP address of the appliance running the Web Services API.

  • API-Token—This token authenticates the session. By default, the session times out after 15 minutes of inactivity.

  • Client-Token—(Optional) This client token is provided by Trellix. For more information about the client token, contact your sales representative.

Example request

GET https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/config

Request headers:

X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
X-FeClient-Token: BigDataInc

Configuration response

HTTP/1.1 [Response Code] [Response Message]
Date: [Date]

Body:

[Configuration Data]
Response

  • Response Code—A standard HTML response code.

    • 200—Request successful.

    • 401—Request unsuccessful due to invalid session token.

  • Response Message—A standard HTML response message.

    • OK—Request successful.

    • Unauthorized—Request unsuccessful due to invalid session token.

  • Date—Standard HTML date format.

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:sysconfig xmlns:ns2="http://www.fireeye.com/fecmsapi/2015/ConfigSchema">
   <sensors>
	<sensor address="127.0.0.1" id="20" sensor_name="AX">
	   <profiles>
		<profile name="winxp-sp3" id="43">
		   <applications>
			<application id="57" name="Windows Explorer"/>
			<application id="43" name="MS Word 2003"/>
			<application id="45" name="MS Excel 2003"/>
			<application id="47" name="MS PowerPoint 2003"/>
			<application id="148" name="MS Word 2003 SP2"/>
			<application id="149" name="MS Excel 2003 SP2"/>
			<application id="150" name="MS PowerPoint 2003 SP2"/>
			<application id="151" name="MS Word 2003 SP3"/>
			<application id="152" name="MS Excel 2003 SP3"/>
			<application id="153" name="MS PowerPoint 2003 SP3"/>
			<application id="44" name="MS Word 2007"/>
			<application id="46" name="MS Excel 2007"/>
			<application id="48" name="MS PowerPoint 2007"/>
			<application id="50" name="MS Outlook 2007"/>
			<application id="154" name="Multiple MS Word X"/>
			<application id="155" name="Multiple MS Excel X"/>
			<application id="156" name="Multiple MS PowerPoint X"/>
			<application id="29" name="Windows Media Player 11.0"/>
			<application id="21" name="InternetExplorer 7.0"/>
			<application id="23" name="InternetExplorer 8.0"/>
			<application id="5" name="InternetExplorer 6.0"/>
			<application id="157" name="Firefox 19.0"/>
			<application id="16" name="Firefox 6.0"/>
			<application id="61" name="Firefox 3.6"/>
			<application id="89" name="Chrome 26.0"/>
			<application id="80" name="Java JDK JRE 6.16"/>
			<application id="205" name="Java JDK JRE 7.13"/>
			<application id="167" name="Java JDK JRE 6.31"/>
			<application id="164" name="Java JDK JRE 7.0"/>
			<application id="212" name="Java JDK JRE 7.9"/>
			<application id="180" name="Multiple Java JDK JRE"/>
			<application id="15" name="QuickTime Player 7.6"/>
			<application id="26" name="RealPlayer 12.0"/>
			<application id="93" name="VLC Media Player 2.0"/>
			<application id="96" name="Multiple Adobe Reader X"/>
			<application id="32" name="Adobe Reader 9.0"/>
			<application id="30" name="Adobe Reader 7.0"/>
			<application id="31" name="Adobe Reader 8.0"/>
			<application id="85" name="Adobe Reader 9.4"/>
			<application id="8" name="Adobe Reader 10.0"/>
			<application id="94" name="Adobe Reader 10.1"/>
			<application id="95" name="Adobe Reader 11.0"/>
			<application id="97" name="Hancom Office Viewer 2007"/>
			<application id="71" name="RunDLL 1.0"/>
			<application id="84" name="Microsoft Compiled HTML Help"/>
			<application id="86" name="Microsoft Windows Help File"/>
			<application id="98" name="Windows Scripting Host"/>
			<application id="99" name="Command Prompt"/>
		   </applications>
		</profile>
		<profile name="win7-sp1" id="65">
		   <applications>
			<application id="67" name="Windows Media Player 12.0"/>
			<application id="57" name="Windows Explorer"/>
			<application id="44" name="MS Word 2007"/>
			<application id="46" name="MS Excel 2007"/>
			<application id="48" name="MS PowerPoint 2007"/>
			<application id="201" name="MS Word 2010 SP2"/>
			<application id="202" name="MS Excel 2010 SP2"/>
			<application id="203" name="MS PowerPoint 2010 SP2"/>
			<application id="204" name="MS Outlook 2010 SP2"/>
			<application id="188" name="MS Word 2013"/>
			<application id="183" name="MS Excel 2013"/>
			<application id="189" name="MS PowerPoint 2013"/>
			<application id="154" name="Multiple MS Word X"/>
			<application id="155" name="Multiple MS Excel X"/>
			<application id="156" name="Multiple MS PowerPoint X"/>
			<application id="2" name="InternetExplorer 9.0"/>
			<application id="158" name="InternetExplorer 10.0"/>
			<application id="23" name="InternetExplorer 8.0"/>
			<application id="211" name="Firefox 13.0"/>
			<application id="88" name="Firefox 17.0"/>
			<application id="107" name="Chrome 25.0"/>
			<application id="164" name="Java JDK JRE 7.0"/>
			<application id="178" name="Java JDK JRE 8.0"/>
			<application id="179" name="Java JDK JRE 7.60"/>
			<application id="180" name="Multiple Java JDK JRE"/>
			<application id="111" name="QuickTime Player 7.7"/>
			<application id="112" name="RealPlayer 16.0"/>
			<application id="93" name="VLC Media Player 2.0"/>
			<application id="96" name="Multiple Adobe Reader X"/>
			<application id="95" name="Adobe Reader 11.0"/>
			<application id="32" name="Adobe Reader 9.0"/>
			<application id="85" name="Adobe Reader 9.4"/>
			<application id="8" name="Adobe Reader 10.0"/>
			<application id="94" name="Adobe Reader 10.1"/>
			<application id="118" name="Hancom Office Viewer 2010"/>
			<application id="71" name="RunDLL 1.0"/>
			<application id="84" name="Microsoft Compiled HTML Help"/>
			<application id="86" name="Microsoft Windows Help File"/>
			<application id="98" name="Windows Scripting Host"/>
			<application id="99" name="Command Prompt"/>
		   </applications>
		</profile>
		<profile name="win7x64-sp1" id="66">
		   <applications>
			<application id="67" name="Windows Media Player 12.0"/>
			<application id="57" name="Windows Explorer"/>
			<application id="183" name="MS Excel 2013"/>
			<application id="188" name="MS Word 2013"/>
			<application id="189" name="MS PowerPoint 2013"/>
			<application id="184" name="MS Outlook 2013"/>
			<application id="170" name="InternetExplorer (64-bit) 11.0"/>
			<application id="169" name="InternetExplorer 11.0"/>
			<application id="2" name="InternetExplorer 9.0"/>
			<application id="104" name="InternetExplorer X"/>
			<application id="159" name="Firefox 26.0"/>
			<application id="10001" name="Firefox 38.0"/>
			<application id="185" name="Chrome 36.0"/>
			<application id="164" name="Java JDK JRE 7.0"/>
			<application id="178" name="Java JDK JRE 8.0"/>
			<application id="179" name="Java JDK JRE 7.60"/>
			<application id="180" name="Multiple Java JDK JRE"/>
			<application id="111" name="QuickTime Player 7.7"/>
			<application id="112" name="RealPlayer 16.0"/>
			<application id="165" name="VLC Media Player 2.1"/>
			<application id="96" name="Multiple Adobe Reader X"/>
			<application id="95" name="Adobe Reader 11.0"/>
			<application id="32" name="Adobe Reader 9.0"/>
			<application id="85" name="Adobe Reader 9.4"/>
			<application id="8" name="Adobe Reader 10.0"/>
			<application id="94" name="Adobe Reader 10.1"/>
			<application id="71" name="RunDLL 1.0"/>
			<application id="84" name="Microsoft Compiled HTML Help"/>
			<application id="86" name="Microsoft Windows Help File"/>
			<application id="98" name="Windows Scripting Host"/>
			<application id="99" name="Command Prompt"/>
		   </applications>
		</profile>
	   </profiles>
	</sensor>
   </sensors>
</ns2:sysconfig>

cURL code sample: configuration

The following code sample can be copied and executed from any command-line interface that includes the cURL library. This sample builds on the authentication cURL code sample.

Note

In this sample, line breaks are added for readability. Remove these line breaks before you paste the code sample into your command-line tool.

curl -qgsSkH --no-progress-bar --header "X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/config

This cURL sample includes the following:

  • -q—This option specifies that the curlrc config file is not read or used. Although this is an optional setting, Trellix recommends that you include this option.

  • -g—This option turns off the URL globbing parser. Although this is an optional setting, Trellix recommends that you include this option.

  • -s—This option turns off the progress meter and error message. Although this is an optional setting, Trellix recommends that you include this option.

  • -S—When used with the -s option, this option shows error messages if your cURL switch fails. Although this is an optional setting, Trellix recommends that you include this option.

  • -k—This option explicitly allows cURL to perform insecure SSL connections and transfers. This allows you to test your SSL connection without installing a CA certificate.

  • -H—This option allows you to specify a custom header with the --header switch.

  • --no-progress-bar—This option suppresses the cURL download progress bar, which can interfere with the request.

  • --header "X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"—This custom header returns the API-Token that was provided during the authentication request. In the authentication cURL code sample, this token was included in the auth.txt file. Replace the token in the sample with the token value received in the response to your authentication request.

    Note

    By default, the X-FeApi-Token times out after 15 minutes of inactivity.

  • https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/config—The configuration request URL. Replace the IP address xxx.xxx.xxx.xxx with the IP address of your appliance.

Results
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:sysconfig xmlns:ns2="http://www.fireeye.com/fecmsapi/2013/ConfigSchema">
   <sensors>
	<sensor address="127.0.0.1" id="20" sensor_name="AX">
	   <profiles>
		<profile name="winxp-sp3" id="43">
		   <applications>
			<application id="57" name="Windows Explorer"/>
			<application id="43" name="MS Word 2003"/>
			<application id="45" name="MS Excel 2003"/>
			<application id="47" name="MS PowerPoint 2003"/>
			<application id="148" name="MS Word 2003 SP2"/>
			<application id="149" name="MS Excel 2003 SP2"/>
			<application id="150" name="MS PowerPoint 2003 SP2"/>
			<application id="151" name="MS Word 2003 SP3"/>
			<application id="152" name="MS Excel 2003 SP3"/>
			<application id="153" name="MS PowerPoint 2003 SP3"/>
			<application id="44" name="MS Word 2007"/>
			<application id="46" name="MS Excel 2007"/>
			<application id="48" name="MS PowerPoint 2007"/>
			<application id="50" name="MS Outlook 2007"/>
			<application id="154" name="Multiple MS Word X"/>
			<application id="155" name="Multiple MS Excel X"/>
			<application id="156" name="Multiple MS PowerPoint X"/>
			<application id="29" name="Windows Media Player 11.0"/>
			<application id="21" name="InternetExplorer 7.0"/>
			<application id="23" name="InternetExplorer 8.0"/>
			<application id="5" name="InternetExplorer 6.0"/>
			<application id="157" name="Firefox 19.0"/>
			<application id="16" name="Firefox 6.0"/>
			<application id="61" name="Firefox 3.6"/>
			<application id="89" name="Chrome 26.0"/>
			<application id="80" name="Java JDK JRE 6.16"/>
			<application id="205" name="Java JDK JRE 7.13"/>
			<application id="167" name="Java JDK JRE 6.31"/>
			<application id="164" name="Java JDK JRE 7.0"/>
			<application id="212" name="Java JDK JRE 7.9"/>
			<application id="180" name="Multiple Java JDK JRE"/>
			<application id="15" name="QuickTime Player 7.6"/>
			<application id="26" name="RealPlayer 12.0"/>
			<application id="93" name="VLC Media Player 2.0"/>
			<application id="96" name="Multiple Adobe Reader X"/>
			<application id="32" name="Adobe Reader 9.0"/>
			<application id="30" name="Adobe Reader 7.0"/>
			<application id="31" name="Adobe Reader 8.0"/>
			<application id="85" name="Adobe Reader 9.4"/>
			<application id="8" name="Adobe Reader 10.0"/>
			<application id="94" name="Adobe Reader 10.1"/>
			<application id="95" name="Adobe Reader 11.0"/>
			<application id="97" name="Hancom Office Viewer 2007"/>
			<application id="71" name="RunDLL 1.0"/>
			<application id="84" name="Microsoft Compiled HTML Help"/>
			<application id="86" name="Microsoft Windows Help File"/>
			<application id="98" name="Windows Scripting Host"/>
			<application id="99" name="Command Prompt"/>
		    </applications>
		</profile>
		<profile name="win7-sp1" id="65">
		   <applications>
			<application id="67" name="Windows Media Player 12.0"/>
			<application id="57" name="Windows Explorer"/>
			<application id="44" name="MS Word 2007"/>
			<application id="46" name="MS Excel 2007"/>
			<application id="48" name="MS PowerPoint 2007"/>
			<application id="201" name="MS Word 2010 SP2"/>
			<application id="202" name="MS Excel 2010 SP2"/>
			<application id="203" name="MS PowerPoint 2010 SP2"/>
			<application id="204" name="MS Outlook 2010 SP2"/>
			<application id="188" name="MS Word 2013"/>
			<application id="183" name="MS Excel 2013"/>
			<application id="189" name="MS PowerPoint 2013"/>
			<application id="154" name="Multiple MS Word X"/>
			<application id="155" name="Multiple MS Excel X"/>
			<application id="156" name="Multiple MS PowerPoint X"/>
			<application id="2" name="InternetExplorer 9.0"/>
			<application id="158" name="InternetExplorer 10.0"/>
			<application id="23" name="InternetExplorer 8.0"/>
			<application id="211" name="Firefox 13.0"/>
			<application id="88" name="Firefox 17.0"/>
			<application id="107" name="Chrome 25.0"/>
			<application id="164" name="Java JDK JRE 7.0"/>
			<application id="178" name="Java JDK JRE 8.0"/>
			<application id="179" name="Java JDK JRE 7.60"/>
			<application id="180" name="Multiple Java JDK JRE"/>
			<application id="111" name="QuickTime Player 7.7"/>
			<application id="112" name="RealPlayer 16.0"/>
			<application id="93" name="VLC Media Player 2.0"/>
			<application id="96" name="Multiple Adobe Reader X"/>
			<application id="95" name="Adobe Reader 11.0"/>
			<application id="32" name="Adobe Reader 9.0"/>
			<application id="85" name="Adobe Reader 9.4"/>
			<application id="8" name="Adobe Reader 10.0"/>
			<application id="94" name="Adobe Reader 10.1"/>
			<application id="118" name="Hancom Office Viewer 2010"/>
			<application id="71" name="RunDLL 1.0"/>
			<application id="84" name="Microsoft Compiled HTML Help"/>
			<application id="86" name="Microsoft Windows Help File"/>
			<application id="98" name="Windows Scripting Host"/>
			<application id="99" name="Command Prompt"/>
		   </applications>
		</profile>
		<profile name="win7x64-sp1" id="66">
		   <applications>
			<application id="67" name="Windows Media Player 12.0"/>
			<application id="57" name="Windows Explorer"/>
			<application id="183" name="MS Excel 2013"/>
			<application id="188" name="MS Word 2013"/>
			<application id="189" name="MS PowerPoint 2013"/>
			<application id="184" name="MS Outlook 2013"/>
			<application id="170" name="InternetExplorer (64-bit) 11.0"/>
			<application id="169" name="InternetExplorer 11.0"/>
			<application id="2" name="InternetExplorer 9.0"/>
			<application id="104" name="InternetExplorer X"/>
			<application id="159" name="Firefox 26.0"/>
			<application id="10001" name="Firefox 38.0"/>
			<application id="185" name="Chrome 36.0"/>
			<application id="164" name="Java JDK JRE 7.0"/>
			<application id="178" name="Java JDK JRE 8.0"/>
			<application id="179" name="Java JDK JRE 7.60"/>
			<application id="180" name="Multiple Java JDK JRE"/>
			<application id="111" name="QuickTime Player 7.7"/>
			<application id="112" name="RealPlayer 16.0"/>
			<application id="165" name="VLC Media Player 2.1"/>
			<application id="96" name="Multiple Adobe Reader X"/>
			<application id="95" name="Adobe Reader 11.0"/>
			<application id="32" name="Adobe Reader 9.0"/>
			<application id="85" name="Adobe Reader 9.4"/>
			<application id="8" name="Adobe Reader 10.0"/>
			<application id="94" name="Adobe Reader 10.1"/>
			<application id="71" name="RunDLL 1.0"/>
			<application id="84" name="Microsoft Compiled HTML Help"/>
			<application id="86" name="Microsoft Windows Help File"/>
			<application id="98" name="Windows Scripting Host"/>
			<application id="99" name="Command Prompt"/>
		   </applications>
		</profile>
	   </profiles>
	</sensor>
   </sensors>
</ns2:sysconfig>
:
Related articles
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy.
Products
Company
Top Features
Solutions
Existing Users
Connect With Us
Sales and Support
Copyright © Abc Inc. All Rights Reserved