System and agent component configuration

You can retrieve and set the configuration of the system component and agent components together using a single file.

Change the system and agent configuration

Complete the following steps to configure system and agent components. Use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration REST endpoint to initialize the configuration.

1. Using a text editor, create an empty text file.

2. Copy and paste an example configuration for system and agent into the file. For sample JSON, see the corresponding agent configuration examples topic.

3. Save the file. For example, as ConfigureSystemAndAgent.json.

4. Open a command line session. Change directory to the location of ConfigureSystemAndAgent.json.

5. Enter the following cURL command (which uses the PUT method) to initialize the system and agent configuration.

curl.exe --ntlm --negotiate -u <UserName> -d "@ConfigureSystemAndAgent.json" -H "Content-Type: application/json" -X PUT "http://localhost:5590/api/v1/configuration"

Notes:
If you installed the agent to listen on a non-default port, update 5590 to the port number in use.
For some of the agent specific configurations to take effect, you must restart the agent.
HistoryRecoveries facet details are not required to be supplied as part of the configuration and supplied values will be ignored. Their results will be restored from the previous states.

If the operation fails due to errors in the configuration, the count of the error and suitable error messages are returned in the result.

Retrieve the system and agent component configuration

The entire application configuration can be retrieved by entering the following cURL command:

curl.exe --ntlm --negotiate -u <UserName> -X GET "http://localhost:5590/api/v1/configuration"

By default, the GET response contains application configuration without the state represented by read-only configuration facets including history recoveries and discoveries. Add the "accept-verbosity" header with the value "verbose" to include read-only configuration facets in the response:

curl.exe --ntlm --negotiate -u <UserName> --header "accept-verbosity: verbose" -X GET "http://localhost:5590/api/v1/configuration"

Note: If you installed the agent to listen on a non-default port, update 5590 to the port number in use.

REST URLs