REST API access: Difference between revisions

From Scalelogic Wiki
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
migrate>Mi-S
No edit summary
No edit summary
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.
<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">. &nbsp;You cannot indicate ports already in use.</span>
Options to set:
<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>
*Port
<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>
The default port is 82. You cannot indicate ports already in use.
<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>
*Username
<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" &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
 
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" &nbsp;https://'''ip_address:port'''/api/v3/product
 
 
- 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

Revision as of 12:03, 15 March 2019

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

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

  • 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


- 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

Retrieved from "http://wiki.scalelogicinc.com/zx/index.php?title=REST_API_access&oldid=1238"