Property Editor REST API

This section describes the Monitor REST API you can use to add, edit and delete properties on a running data server. This means that you can update connection properties without restarting the data server.

To complete these instructions you need the abbreviated name for the Monitor--also called the PackageName. For example, the PackageName for the Solution Package for Solace is solmon. Where indicated, you would:

replace <PackageName> with solmon

For example, change:

node main.js -action=getPropertyDescriptions -sp=<PackageName>

to:

node main.js -action=getPropertyDescriptions -sp=solmon

A sample node.js-based application is available in the rtvapm/sampleapps/propeditor directory which you can use to edit properties via the same rtvadmin servlet that is used by the RTView Configuration Application. This sample application also serves as an example of how to post to the rtvadmin servlet from your own application. For instructions about how to setup and run the sample application see the README.txt file in the same directory.

Two use cases are supported:

•

Import Initial Properties & Connections into Configuration Application: Rather than manually entering each connection, you can use the REST API to import initial connections into the Configuration Application. You can subsequently edit those connections using the Configuration Application.

•

Automate Connection Updates: Rather than using the Configuration Application to manage your connection properties, you can use the REST API to add, edit and delete connections. This is useful when you have an automated system for provisioning and want to automatically add monitoring as part of the provisioning process. These connections will not be included in the Configuration Application and will only be edited via the REST API.

Also see Design Notes for details about Supported API Actions , Filenames , Sample json, Adding, Editing, Deleting JsonPrimitive Properties, Adding and Editing JsonObject Properties, Deleting JsonObject Properties, Updating vs. Restarting Data Servers and High Availability .

This section also contains:

•

Import Initial Properties & Connections into Configuration Application

•

Automate Connection Updates

•

Encrypt Property Text

•

Design Notes