NetXMS WebAPI - Revision history

AlexKirhenshtein: Text replacement - "^" to "{{deprecated}}"

2022-09-13T16:13:25Z

Text replacement - "^" to "{{deprecated}}"

← Older revision		Revision as of 16:13, 13 September 2022
Line 1:		Line 1:
	The NetXMS WebAPI is being developed to support larger integration possibilities for the NetXMS server and is based on the RESTful philosophy. The API currently supports [[NetXMS Grafana datasource setup\|Grafana integration]] and external tool authentication which will be described shortly. The NetXMS WebAPI is currently in very early development!		{{deprecated}}The NetXMS WebAPI is being developed to support larger integration possibilities for the NetXMS server and is based on the RESTful philosophy. The API currently supports [[NetXMS Grafana datasource setup\|Grafana integration]] and external tool authentication which will be described shortly. The NetXMS WebAPI is currently in very early development!

	== Requirements ==		== Requirements ==

Victor at 07:42, 2 November 2018

2018-11-02T07:42:19Z

← Older revision		Revision as of 07:42, 2 November 2018
Line 12:		Line 12:
	3. Run {{#tag:syntaxhighlight\|mvn package\|lang=bash}}		3. Run {{#tag:syntaxhighlight\|mvn package\|lang=bash}}
	4. Copy the resulting .war file from {{#tag:syntaxhighlight\|/targets/netxms-websvc-2.1-M3.war\|lang=bash}} to your web server.<br />		4. Copy the resulting .war file from {{#tag:syntaxhighlight\|/targets/netxms-websvc-2.1-M3.war\|lang=bash}} to your web server.<br />
	5. Create a {{#tag:syntaxhighlight\|nxapisrv.properties\|lang=bash}} file and place it in the property file location of your web server and specify the NetXMS Server address with the {{#tag:syntaxhighlight\|~~NXServer~~=\|lang=bash}} property.		5. Create a {{#tag:syntaxhighlight\|nxapisrv.properties\|lang=bash}} file and place it in the property file location of your web server and specify the NetXMS Server address with the {{#tag:syntaxhighlight\|netxms.server.address=\|lang=bash}} property. If server is running on non-standard port specify it with {{#tag:syntaxhighlight\|netxms.server.port=\|lang=bash}} property.

	== External tool authentication ==		== External tool authentication ==

Victor at 07:47, 29 June 2017

2017-06-29T07:47:51Z

← Older revision		Revision as of 07:47, 29 June 2017
Line 11:		Line 11:
	2. Navigate to {{#tag:syntaxhighlight\|NETXMS_GIT/src/server/nxapisrv/java\|lang=bash}}		2. Navigate to {{#tag:syntaxhighlight\|NETXMS_GIT/src/server/nxapisrv/java\|lang=bash}}
	3. Run {{#tag:syntaxhighlight\|mvn package\|lang=bash}}		3. Run {{#tag:syntaxhighlight\|mvn package\|lang=bash}}
	4. Copy the resulting .war file from {{#tag:syntaxhighlight\|/targets/netxms-websvc-2.1-M3.war\|lang=bash}} to your web server.		4. Copy the resulting .war file from {{#tag:syntaxhighlight\|/targets/netxms-websvc-2.1-M3.war\|lang=bash}} to your web server.<br />
	5. Create a {{#tag:syntaxhighlight\|nxapisrv.properties\|lang=bash}} file and place it in the property file location of your web server and specify the NetXMS Server address with the {{#tag:syntaxhighlight\|NXServer=\|lang=bash}} property.		5. Create a {{#tag:syntaxhighlight\|nxapisrv.properties\|lang=bash}} file and place it in the property file location of your web server and specify the NetXMS Server address with the {{#tag:syntaxhighlight\|NXServer=\|lang=bash}} property.

Victor at 07:46, 29 June 2017

2017-06-29T07:46:31Z

← Older revision		Revision as of 07:46, 29 June 2017
Line 10:		Line 10:
	1. Clone the NetXMS git repository to a folder on your computer.		1. Clone the NetXMS git repository to a folder on your computer.
	2. Navigate to {{#tag:syntaxhighlight\|NETXMS_GIT/src/server/nxapisrv/java\|lang=bash}}		2. Navigate to {{#tag:syntaxhighlight\|NETXMS_GIT/src/server/nxapisrv/java\|lang=bash}}
	3. Run {{#tag:syntaxhighlight\|mvn ~~install~~\|lang=bash}}		3. Run {{#tag:syntaxhighlight\|mvn package\|lang=bash}}
	4. Copy the resulting .war file from {{#tag:syntaxhighlight\|/targets/netxms-websvc-2.1-M3.war\|lang=bash}} to your web server.		4. Copy the resulting .war file from {{#tag:syntaxhighlight\|/targets/netxms-websvc-2.1-M3.war\|lang=bash}} to your web server.
	5. Create a {{#tag:syntaxhighlight\|nxapisrv.properties\|lang=bash}} file and place it in the property file location of your web server and specify the NetXMS Server address with the {{#tag:syntaxhighlight\|NXServer=\|lang=bash}} property.		5. Create a {{#tag:syntaxhighlight\|nxapisrv.properties\|lang=bash}} file and place it in the property file location of your web server and specify the NetXMS Server address with the {{#tag:syntaxhighlight\|NXServer=\|lang=bash}} property.

TatjanaDubrovica: Created page with "The NetXMS WebAPI is being developed to support larger integration possibilities for the NetXMS server and is based on the RESTful philosophy. The API currently supports Net..."

2017-05-03T14:26:35Z

Created page with "The NetXMS WebAPI is being developed to support larger integration possibilities for the NetXMS server and is based on the RESTful philosophy. The API currently supports Net..."

New page

The NetXMS WebAPI is being developed to support larger integration possibilities for the NetXMS server and is based on the RESTful philosophy. The API currently supports [[NetXMS Grafana datasource setup|Grafana integration]] and external tool authentication which will be described shortly. The NetXMS WebAPI is currently in very early development!

== Requirements ==
* A running instance of the NetXMS server.
* Access to a web server.
* Git tools
* Maven tools

== Setup ==
1. Clone the NetXMS git repository to a folder on your computer.
2. Navigate to {{#tag:syntaxhighlight|NETXMS_GIT/src/server/nxapisrv/java|lang=bash}}
3. Run {{#tag:syntaxhighlight|mvn install|lang=bash}}
4. Copy the resulting .war file from {{#tag:syntaxhighlight|/targets/netxms-websvc-2.1-M3.war|lang=bash}} to your web server.
5. Create a {{#tag:syntaxhighlight|nxapisrv.properties|lang=bash}} file and place it in the property file location of your web server and specify the NetXMS Server address with the {{#tag:syntaxhighlight|NXServer=|lang=bash}} property.

== External tool authentication ==
It is possible to use the NetXMS WebAPI to for authentication in external tools. This can be done by sending a POST request that includes the following JSON data:
{{#tag:syntaxhighlight|{"login":"admin","password":"netxms"}|lang=bash}}
To the path:
{{#tag:syntaxhighlight|API_HOME/authenticate|lang=bash}}

The API will return a 200 response if the credentials are correct, a 400 response if either login or password is not provided or 401 if the provided credentials are incorrect.