Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Adapter for MQTT

Configure system and adapter

  • Last UpdatedNov 10, 2025
  • 2 minute read

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

To change the system and adapter configuration:

  1. To initialize the configuration, use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/system/components REST endpoint.

  2. Create an empty text file using a text editor.

  3. Copy and paste an example configuration for system and adapter into the file.

    For sample JSON, see the corresponding adapter configuration examples topic.

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

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

    curl -d "@ConfigureSystemAndAdapter.json" -H "Content-Type: application/json" -X PUT "http://localhost:5590/api/v1/configuration"

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

Note: In order for some of the adapter specific configurations to take effect, you have to restart the adapter. Discoveries and 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 system and adapter configuration

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

curl -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 --header "accept-verbosity: verbose" -X GET "http://localhost:5590/api/v1/configuration"

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

TitleResults for “How to create a CRG?”Also Available in