|
|
| (9 intermediate revisions by 3 users not shown) |
| 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>
| | This functionality is available in: '''System Settings > Administration > REST API access''' |
| <div dir="ltr" style="line-height:1.38; margin-top:0pt; margin-bottom:0pt"><br/></div>
| |
| <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">Options to set:</span>
| |
| <ul style="margin-top:0pt;margin-bottom:0pt;">
| |
| <li><span style="font-size:12.666666666666666px; font-family:Arial; color:#000000; background-color:#ffffff; font-weight:700; font-style:normal; font-variant:normal; text-decoration:none; vertical-align:baseline">Port</span></li>
| |
| </ul>
| |
|
| |
|
| <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">. You cannot indicate ports already in use.</span>
| |
| <ul style="margin-top:0pt;margin-bottom:0pt;">
| |
| <li><span style="font-size:12.666666666666666px; font-family:Arial; color:#000000; background-color:#ffffff; font-weight:700; font-style:normal; font-variant:normal; text-decoration:none; vertical-align:baseline">Username</span></li>
| |
| </ul>
| |
|
| |
|
| <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>
| |
| <ul style="margin-top:0pt;margin-bottom:0pt;">
| |
| <li><span style="font-size:12.666666666666666px; font-family:Arial; color:#000000; background-color:#ffffff; font-weight:700; font-style:normal; font-variant:normal; text-decoration:none; vertical-align:baseline">Password</span></li>
| |
| </ul>
| |
|
| |
|
| <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>
| | Using this function, you can manage the system remotely using the Representational State Transfer (REST). For authentication HTTP Basic authentication (BA) is used. |
| <ul style="margin-top:0pt;margin-bottom:0pt;">
| |
| <li><span style="font-size:12.666666666666666px; font-family:Arial; color:#000000; background-color:#ffffff; font-weight:700; font-style:normal; font-variant:normal; text-decoration:none; vertical-align:baseline">Confirm password</span></li>
| |
| </ul>
| |
|
| |
|
| <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>
| | Options to set: |
| <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">Below examples of requests using curl command:</span>
| |
| <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 GET request:</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">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" 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>
| | *'''Port''' - which as default is set to 82. You cannot indicate ports already in use. |
| <div dir="ltr" style="line-height:1.38; margin-top:0pt; margin-bottom:0pt"><br/></div>
| | *'''Username''' - is an authentication username. The default is “admin”. |
| <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''' - which is used for authentication. |
| | *'''Password confirmation''' - means retype your new password. |
| | |
| | |
| | |
| | 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]] |
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:
- Port - which as default is set to 82. You cannot indicate ports already in use.
- Username - is an authentication username. The default is “admin”.
- Password - which is used for authentication.
- Password confirmation - means retype your new password.
Below are examples of requests using the curl command:
curl -X GET -u username:password -i -k -H "Content-type: application/json" https://ip_address:port/api/v3/product
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
- for POST request:
Note! In the example below, LDAP must be enabled in the system. Otherwise, an error occurs.
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