op=1 or op=OPEN

This HTTP request open a new session with the server. This should be the first operation you do when you want to work with the VSCP REST interface. If all goes well you will be handed a session key and you should use this session key in further calls.

For GET requests you put the key in the request URL just as any other value


and for PUT HTTP requests you place the key in the header as

vscpsession: d1c13eb83f52f319f14d167962048521 

If you do not use this session key within five minutes it will be invalid and you have to do a new open HTTP request.

General format:



  • op - Set to 1|open

  • format - Can be 0|plain, 1|csv, 2|xml, 3|json or 4|jsonp.

  • vscpuser - A valid username.

  • vscpuser - A valid password.

note the vscpsecret has been changed from a md5 password to a clear text password from version

HTTP Request with GET


You can interact with the vscp demo server right now by plugging this into your browser.

See "Read Event" section of REST Interface documentation for more details.

CURL HTTP Request with GET

    curl -X GET "http://localhost:8884/vscp/rest?vscpuser=admin&vscpsecret=secret&format=plain&op=open"

you should get a response with something like

1 1 Success vscpsession=8fa1052598a988ad5166bc9c65f0a167 nEvents=0

where 8fa1052598a988ad5166bc9c65f0a167 is the session id to use for further calls.

CURL HTTP Request with POST

curl -X POST "http://localhost:8884/vscp/rest" \
    -H "vscpuser: admin" \
    -H "vscpsecret: d50c3180375c27927c22e42a379c3f67" \ 
    -d "op=open&format=plain"


There is a a demo app in the source tree, that demonstrates this functionality using JavaScript.

Bash sample

The following bash script fetches a session ID and automatically uses it to read VSCP events in plain format.


# Angus Galloway
# fetch a session ID from the daemon, it is valid for 5 minutes.

# option -s for silent
# option -X for specifying request cmd

curl -s -X GET "" > temp_file

awk '{ split($4,arr,"="); print "curl -X GET \""arr[2]"&format=plain&op=4\""; }' temp_file

# execute result

awk '{ split($4,arr,"="); print "curl -X GET \""arr[2]"&format=plain&op=4\"" | "bash"; }' temp_file

JavaScript Request with JSONP

    url: '',
    type : "GET",
    jsonpCallback: 'handler',
    cache: true,
    dataType: 'jsonp',
    success: function(response) {
        // response will be a JavaScript
        // array of objects
        console.log("Success = " + response.success );
        console.log("Code = " + response.code );
        console.log("Message = " + response.message );
        console.log("Description = " + response.description );                    
        console.log("Sessionkey = " + response.vscpsession );
        console.log("nEvents = " + response.nEvents );

        if (  response.success ) {
            console.log("Session key assigned to global object " + typeof( response.success) );
            gVscpSessionKey = response.vscpsession;
    error: function( xhr, status, error ) {
        console.log( error + " Status:" + status );

Use the returned vscpsession key for all other calls.


With the format parameter you set the format your want the response represented as. The following shows the positive outcome of the Open HTTP request for all formats available.

Response for format=plain
1 1 Success vscpsession=d1c13eb83f52f319f14d167962048521 nEvents=0
Response for format=csv
1,1,Success,Success. 1,1,Success,Success,d1c13eb83f52f319f14d167962048521
response for format=xml
<vscp-rest success="true" 
    <vscpsession>d1c13eb83f52f319f14d167962048521 </vscpsession>
response for format=json
{"success":true,"code":1,"message":"success","description":"Success","vscpsession":"d1c13eb83f52f319f14d167962048521 ","nEvents":0}
response for format=jsonp
typeof handler === 'function' && handler({"success":true,"code":1,"message":"success","description":"Success","vscpsession":"d1c13eb83f52f319f14d167962048521 ","nEvents":0});

Very Simple Control Protocol
Thu Jan 17 2019 17:41:36 GMT+0000 (UTC)
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.

results matching ""

    No results matching ""