The commands that are available are described on this page.
The web interface is available at
or for a SSL connection
for simplicity we only show the non SSL URL's in this documentation.
You can use GET or POST HTTP requests. They differ a little in format as the POST version send authentication information in the header, but in all other senses they are the same.
curl -X POST "http://host:port/vscp/rest" \ -H "vscpuser: user" \ -H "vscpsecret: password" \ -H "vscpsession: session" \ -d "vscpuser=admin&vscpsecret=secret&\ op=open&format=plain"
A REST session normally lives between open and close HTTP requests. If for some reason a rest session is not closed and not accessed within ten minutes the system will regard it as an orphan and close it. To issue a status HTTP request from time to time is a good way to hold a session open. But any other of the HTTP requests that need the session value also will do.
Unlike all of the other methods, JSONP responses will always be sent with the HTTP 200 success code. We respond this way for the JSONP format because browsers will not parse the response body when the server replies with a HTTP error code.
This document is licensed under Creative Commons BY 4.0 and can be freely copied, redistributed, remixed, transformed, built upon as long as you give credits to the author.