REST API access - Revision history

Pa-P: 1 revision

2023-11-03T10:03:07Z

1 revision

← Older revision	Revision as of 10:03, 3 November 2023
(No difference)

Pa-P at 07:42, 12 May 2023

2023-05-12T07:42:13Z

← Older revision		Revision as of 07:42, 12 May 2023
Line 1:		Line 1:
	~~Using this function, you can manage the system remotely using the Representational State Transfer (~~REST~~). For authentication HTTP Basic authentication (BA) is used.~~		This functionality is available in: '''System Settings > Administration > REST API access'''



			Using this function, you can manage the system remotely using the Representational State Transfer (REST). For authentication HTTP Basic authentication (BA) is used.

	Options to set:		Options to set:

	*'''Port'''		*'''Port''' - which as default is set to 82. You cannot indicate ports already in use.
			*'''Username''' - is an authentication username. The default is “admin”.
	~~The~~ default ~~port~~ is ~~'''~~82~~'''~~. You cannot indicate ports already in use.		*'''Password''' - which is used for authentication.
			*'''Password confirmation''' - means retype your new password.
	*'''Username'''

	~~Authentication user name~~. ~~Default~~ is ~~“'''admin'''”~~.

	*'''Password'''

	~~Password~~ used for authentication.

	*'''~~Confirm password~~'''

	~~Please~~ retype your new password.



	~~Below examples of requests using curl command:~~



	~~- for GET request:~~

	~~curl -X GET -u '''admin:mypassword''' -i -k -H "Content-type: application/json"  https://'''ip_address:port'''/api/v3/product~~

	~~<br/>- for PUT request:~~

	curl ~~-X PUT -u '''admin~~:~~password''' -i -k -H "Content-Type: application/json" -d '{"ip_address": "121.123.123.123", "enabled": true, "port": 1, "protocol": "udp"}' https://'''ip_address:port'''/api/v3/services/remote-logging~~		Below are examples of requests using the curl command:

			*for GET request:
			<pre>curl -X GET -u username:password -i -k -H "Content-type: application/json" https://ip_address:port/api/v3/product</pre>
			*for PUT request:
			<pre>curl -X PUT -u username:password -i -k -H "Content-type: application/json" -d '{"ip_address": "121.123.123.123", "enabled": true, "port": 1, "protocol": "udp"}' https://ip_address:port/api/v3/services/remote-logging</pre>
			*for POST request:<br/>'''Note!''' In the example below, LDAP must be enabled in the system. Otherwise, an error occurs.
			<pre>curl -X POST -u username:password -i -k -H "Content-type: application/json" -d '{"name": "username", "password": "password", "backend_name": "LDAP"}' https://ip_address:port/api/v3/users</pre>
	[[Category:Help topics]]		[[Category:Help topics]]

Pa-P: Pa-P moved page REST access to REST API access

2023-05-12T07:41:35Z

Pa-P moved page REST access to REST API access

@@ Line 1: / Line 1: @@
-This functionality is available in: '''System Settings > Administration > REST API access'''
+Using this function, you can manage the system remotely using the Representational State Transfer (REST). For authentication HTTP Basic authentication (BA) is used.
-*'''Port''' - which as default is set to 82. You cannot indicate ports already in use.
+- for GET request:
-Below are examples of requests using the curl command:
+curl -X PUT -u '''admin:password''' -i -k -H "Content-Type: application/json" -d '{"ip_address": "121.123.123.123", "enabled": true, "port": 1, "protocol": "udp"}' https://'''ip_address:port'''/api/v3/services/remote-logging
 [[Category:Help topics]]

Da-F at 12:33, 11 April 2023

2023-04-11T12:33:56Z

← Older revision		Revision as of 12:33, 11 April 2023
Line 1:		Line 1:
	~~Using this function, you can manage the system remotely using the Representational State Transfer (~~REST~~). For authentication HTTP Basic authentication (BA) is used.~~		This functionality is available in: '''System Settings > Administration > REST API access'''



			Using this function, you can manage the system remotely using the Representational State Transfer (REST). For authentication HTTP Basic authentication (BA) is used.

	Options to set:		Options to set:

	*'''Port'''		*'''Port''' - which as default is set to 82. You cannot indicate ports already in use.
			*'''Username''' - is an authentication username. The default is “admin”.
	~~The~~ default ~~port~~ is ~~'''~~82~~'''~~. You cannot indicate ports already in use.		*'''Password''' - which is used for authentication.
			*'''Password confirmation''' - means retype your new password.
	*'''Username'''

	~~Authentication user name~~. ~~Default~~ is ~~“'''admin'''”~~.

	*'''Password'''

	~~Password~~ used for authentication.

	*'''~~Confirm password~~'''

	~~Please~~ retype your new password.



	~~Below examples of requests using curl command:~~



	~~- for GET request:~~

	~~curl -X GET -u '''admin:mypassword''' -i -k -H "Content-type: application/json"  https://'''ip_address:port'''/api/v3/product~~

	~~<br/>- for PUT request:~~

	curl ~~-X PUT -u '''admin~~:~~password''' -i -k -H "Content-Type: application/json" -d '{"ip_address": "121.123.123.123", "enabled": true, "port": 1, "protocol": "udp"}' https://'''ip_address:port'''/api/v3/services/remote-logging~~		Below are examples of requests using the curl command:

			*for GET request:
			<pre>curl -X GET -u username:password -i -k -H "Content-type: application/json" https://ip_address:port/api/v3/product</pre>
			*for PUT request:
			<pre>curl -X PUT -u username:password -i -k -H "Content-type: application/json" -d '{"ip_address": "121.123.123.123", "enabled": true, "port": 1, "protocol": "udp"}' https://ip_address:port/api/v3/services/remote-logging</pre>
			*for POST request:<br/>'''Note!''' In the example below, LDAP must be enabled in the system. Otherwise, an error occurs.
			<pre>curl -X POST -u username:password -i -k -H "Content-type: application/json" -d '{"name": "username", "password": "password", "backend_name": "LDAP"}' https://ip_address:port/api/v3/users</pre>
	[[Category:Help topics]]		[[Category:Help topics]]

Ma-W at 12:09, 15 March 2019

2019-03-15T12:09:50Z

← Older revision		Revision as of 12:09, 15 March 2019
Line 34:		Line 34:

	curl -X PUT -u '''admin:password''' -i -k -H "Content-Type: application/json" -d '{"ip_address": "121.123.123.123", "enabled": true, "port": 1, "protocol": "udp"}' https://'''ip_address:port'''/api/v3/services/remote-logging		curl -X PUT -u '''admin:password''' -i -k -H "Content-Type: application/json" -d '{"ip_address": "121.123.123.123", "enabled": true, "port": 1, "protocol": "udp"}' https://'''ip_address:port'''/api/v3/services/remote-logging

			[[Category:Help topics]]

Ma-W at 12:09, 15 March 2019

2019-03-15T12:09:05Z

← Older revision		Revision as of 12:09, 15 March 2019
Line 7:		Line 7:
	*'''Port'''		*'''Port'''

	The default port is 82. You cannot indicate ports already in use.		The default port is '''82'''. You cannot indicate ports already in use.

	*'''Username'''		*'''Username'''

Ma-W at 12:08, 15 March 2019

2019-03-15T12:08:48Z

← Older revision		Revision as of 12:08, 15 March 2019
Line 24:		Line 24:

	Below examples of requests using curl command:		Below examples of requests using curl command:



	- for GET request:		- for GET request:

Ma-W at 12:04, 15 March 2019

2019-03-15T12:04:53Z

← Older revision		Revision as of 12:04, 15 March 2019
Line 19:		Line 19:
	*'''Confirm password'''		*'''Confirm password'''

	Please retype your new password		Please retype your new password.



	Below examples of requests using curl command:		Below examples of requests using curl command:

Ma-W at 12:04, 15 March 2019

2019-03-15T12:04:21Z

← Older revision		Revision as of 12:04, 15 March 2019
Line 1:		Line 1:
	Using this function, you can manage the system remotely using the Representational State Transfer (REST). For authentication HTTP Basic authentication (BA) is used.		Using this function, you can manage the system remotely using the Representational State Transfer (REST). For authentication HTTP Basic authentication (BA) is used.



	Options to set:		Options to set:

	*Port		*'''Port'''

	The default port is 82. You cannot indicate ports already in use.		The default port is 82. You cannot indicate ports already in use.

	*Username		*'''Username'''

	Authentication user name. Default is “'''admin'''”.		Authentication user name. Default is “'''admin'''”.

	*Password		*'''Password'''

	Password used for authentication.		Password used for authentication.

	*Confirm password		*'''Confirm password'''

	Please retype your new password		Please retype your new password
Line 25:		Line 27:
	curl -X GET -u '''admin:mypassword''' -i -k -H "Content-type: application/json"  https://'''ip_address:port'''/api/v3/product		curl -X GET -u '''admin:mypassword''' -i -k -H "Content-type: application/json"  https://'''ip_address:port'''/api/v3/product

			<br/>- for PUT request:
	- for PUT request:

	curl -X PUT -u '''admin:password''' -i -k -H "Content-Type: application/json" -d '{"ip_address": "121.123.123.123", "enabled": true, "port": 1, "protocol": "udp"}' https://'''ip_address:port'''/api/v3/services/remote-logging		curl -X PUT -u '''admin:password''' -i -k -H "Content-Type: application/json" -d '{"ip_address": "121.123.123.123", "enabled": true, "port": 1, "protocol": "udp"}' https://'''ip_address:port'''/api/v3/services/remote-logging

Ma-W at 12:03, 15 March 2019

2019-03-15T12:03:46Z

@@ Line 1: / Line 1: @@
-<span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">Using this function, you can manage the system remotely using the Representational State Transfer (REST). For authentication </span><span style="font-size:14px;  font-family:Arial;  color:#252525;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">HTTP Basic authentication (BA) is used.</span>
+Using this function, you can manage the system remotely using the Representational State Transfer (REST). For authentication HTTP Basic authentication (BA) is used.
-<span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">The default port is </span><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:700;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">82</span><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">. &nbsp;You cannot indicate ports already in use.</span>
+Options to set:
-<span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">Authentication user name. Default is “</span><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:700;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">admin</span><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">”.</span>
+*Port
-<span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">Password used for authentication.</span>
+The default port is 82. You cannot indicate ports already in use.
-<span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">Please retype your new password.</span>
+*Username
-<span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">curl -X GET -u </span><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:700;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">admin:mypassword</span><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">-i -k -H "Content-type: application/json" &nbsp;https:/</span><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:700;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">/ip_address:port</span><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">/api/v3/product</span>
+Authentication user name. Default is “'''admin'''”.
-<div dir="ltr" style="line-height:1.38;  margin-top:0pt;  margin-bottom:0pt"><br/></div>
-<span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">- for PUT request:</span><br/><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">curl -X PUT -u </span><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:700;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">admin:password</span><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">-i -k -H "Content-Type: application/json" -d '{"ip_address": "121.123.123.123", "enabled": true, "port": 1, "protocol": "udp"}' https://</span><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:700;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">ip_address:port</span><span style="font-size:14.666666666666666px;  font-family:Arial;  color:#000000;  background-color:#ffffff;  font-weight:400;  font-style:normal;  font-variant:normal;  text-decoration:none;  vertical-align:baseline">/api/v3/services/remote-logging</span>
+*Password