The REST API is an interface that allows third-party applications to input data into the Retain archive. For third-party applications to utilize the REST API, they must have a key provided by Micro Focus.
Path: Retain Server Manager > >
The REST API tab contains the following panels:
The REST API is an input protocol only. For Archive security, the API prohibits migrating data out of the Retain Archive. There are also limits placed in each applications API license file to protect the integrity of the data being input into the archive, based on the application.
To gain a credentialed key for a third party application, contact a Micro Focus sales representative. Use of the REST API will require a REST API base license, and an application specific license for each desired application.
Some modules use the REST API for data collection. You need to create a collector to connect to the message system. You may have multiple REST collectors.
Table 2-22 Using the REST Collectors Panel
Option, Field, or Sub-panel
Information and/or Action
A name of your choosing, preferably one that identified the system that will use it to archive to your Retain server.
Create a REST Collector by providing:
The Collector Name can be anything you want, but we recommend something easy to identify with the system it connects with. A Key and Secret will be created for the collector. The Key and Secret will be used on the message system side of the system for authentication.
Then press "Add collector" to enable the collector.
Export the collector allows you to export the Key and Secret to disk for use with the message system.
Send exported file to your message service provider.
Delete removes the collector.