UCX series – User's Manual 72
POST Command with Basic Authentication Example
Switch video crosspoint
curl --user <username>:<password> -X POST -i <ip>/api/<NodePath>/<PropertyName> --data <value>
C:\Users\Juca>curl --user admin:pwrd -X POST -H -i http://192.168.0.110/api/V1/MEDIA/VIDEO/XP/switch --data I2:O1
OK
HTTPS Command Example 2.
Switch video crosspoint
curl -X POST -k -i <ip>/api/<NodePath>/<PropertyName> --data <value>
C:\Users\Juca>curl -X POST -k -i https://192.168.0.110/api/V1/MEDIA/VIDEO/XP/switch --data I2:O1
HTTP/1.1 200 OK
X-Powered-By: Express
Content-Type: text/plain; charset=utf-8
Content-Length: 2
ETag: W/"2-nOO9QiTIwXgNtWtBJezz8kv3SLc"
Date: Sun, 28 May 2034 12:28:20 GMT
cache-control: max-age=86400,private
Server: lighttpd/1.4.56
OK
Protocol Rules
Command Structure Example
The examples below show, how to apply the REST API in different environments:
Curl in Command Line Terminal
ɯ
REST API Client in Mozilla
Method: POST
URL:
Body content type:
Body: I2:O1
General Rules
▪ All names and parameters are case-insensitive.
▪
▪ The node name consists of letters of the English alphabet and numbers.
▪
▪ The HTTP server is available on port 80, the HTTPS server is available on port 443.
▪
▪ Header contains the IP address (or hostname) and the nodepath.
▪
▪
▪ The node paths describe the exact location of the node, listing each parent node up to the root.
▪
▪ There is no maxiumum size or character length of the request.
header: POST http://192.168.0.50/api/V1/MEDIA/VIDEO/XP/switch HTTP/1.1
body: I2:O1
header: 200 OK
Part of the HTTP structure
Request
HTTP method
(GET/POST/PUT)
IP address or hostname of
the target device
Response
Part of the HTTP structure
Nodepath
version
Method
/property
Value of the property/method
To Next Page
Loading...
Need help?
General
