5.1 List of APIs

The following table lists APIs that can be used with the user-created plug-in of JP1/IM.

Table 5‒1: List of APIs of the user-created plug-in (API related to JP1/IM - Manager)
Category	API name	Description
User authentication	Login	Logs in to the Intelligent Integrated Management Base.
	Logout	Logs out from the Intelligent Integrated Management Base.
	Initial secret issue	Issue initial secret.
	IM Client secret delete	Delete IM client secret that you have added to the database.
	IM Client secret issue	Issue IM client secret and add it in the database.
	IM Client list acquisition	Retrieve a list of added IM client IDs.
Link information	Link information acquisition	Gets the link information that represents order relationships between objects.
Link information	Link type list acquisition	Gets the list of types of link information.
Event management	Event search	Searches the integrated monitoring database for events based on specified conditions.
	Event detailed information acquisition	Gets the details of a specified event.
	Event status change	Changes the event status of specified events.
	Event generation	Generates the specified event.
	JP1 Event converter	This function converts event data reported from an external system to JP1 events and issues them.
Performance information	Plug-in processing execution	Executes plug-in operations for performance information.
System status monitoring	IM management node related information generation	Obtains the system configuration information and generates a configuration management tree File.
	IM management node related information reflection	Reflect configuration management tree file in Intelligent Integrated Management Base.
	IM management node information acquisition	Gets the information of IM management nodes collected from JP1/AJS3, JP1/PFM, JP1/IM, JP1/Base, and others.
	Configuration management tree information acquisition	Gets the configuration information of IM management nodes (management groups or management objects) as a tree.
	IM management node status acquisition	Gets the status information of all IM management nodes (management groups or management objects).
	Suggestion mapping information acquisition	Gets information regarding the mapping between IM management nodes and suggestion IDs.
Proxy	Proxy credential setup	Sets the authentication user and password of the proxy server.
Linked product	URL information acquisition	Gets the URL to start a linked product configured in an IM management node.
Trend	Metric list acquisition	Gets the list of metrics for the specified SID.
	Time-series data acquisition	Gets time-series data for the specified SID.
	Write Trend Data	Writes trend data to Trend data Management Database. The data to be written can be specified in JSON format.
Information management	Version information acquisition	Gets the JP1/IM version and REST API versions.
Suggestion	Previous execution history acquisition	Gets a history of previously executed response actions.
	Response action suggestion	Suggests response actions appropriate to the system status.
	Response action execution	Executes a response action.
OpenID authentication	Single sign-on mapping definition application	Applies the mapping information defined in the single sign-on mapping definition file (`imdd_sso_mapping.properties`) to the Intelligent Integrated Management Base.
Distribution	Get distribution (File download)	Downloads the distribution specified in the request line (File).
Execute for Auto/Manual Response Action	Obtain execution result of Response Action	Get Execute of Response Action.
	Manual execution of Response Action	Response Action(manual) is performed.
	Convert event-takeover info	Event information is inherited.
Definition file Manipulation	Get definition file list	Retrieves a list of definition file.
	Get definition file	Retrieve the definition file.
	Delete definition file	Delete the definition file.
	Updated definition file	Update definition file.
Integrated agent Administration	Retrieve integrated agent info	Retrieve integrated agent info.
	Delete integrated agent info	Delete integrated agent info.
	Retrieve Secret List	Retrieve a list of secrets that JP1/IM agent control base manages.
	Add, update, delete the secrets	Add, update, and delete the secrets that you want JP1/IM agent control base to manage.
Lower manager Info Management	Retrieve lower manager info list	Retrieve the base and relay manager under the control of Integrated manager.
	Add lower manager info	Add the base or relay manager under the information of Integrated manager.
	Delete lower manager info	Delete the base or relay manager under the control of Integrated manager.

Table 5‒2: List of APIs of the user-created plug-in (API related to JP1/IM - Agent)
Category	API name^#	Description
Prometheus server	Reload Prometheus server	Refreshes Prometheus server definition file and reflects it in Prometheus server operation.
Prometheus server	Prometheus server health check	Performs a health check of Prometheus server. The status code always returns 200.
Alertmanager	Reload Alertmanager	Refreshes Alertmanager definition file and reflects it in Alertmanager operation.
	Alertmanager health check	Performs a health check of Alertmanager. The status code always returns 200.
	Get silence list of Alertmanager	Retrieves a list of silence created in Alertmanager in JSON format.
	Silence creation of Alertmanager	Pass JSON form of silence's setting and create a silence in Alertmanager.
	Silence Revocation of Alertmanager	Revokes (expires immediately) silence created in Alertmanager.
	Get silence of Alertmanager	Retrieves the specified silence in JSON format.
Blackbox exporter	Reload Blackbox exporter	Refreshes Blackbox exporter definition file and reflects it in Blackbox exporter operation.
API for scrape of Exporter used by JP1/IM - Agent		Execute scrape of Exporter for which you want to scrape Prometheus server.

#: API do not have access-control functions. You can limit the source hosts of API by specifying a connectable IP address for the ports that the firewall allows.

To Page Top