Skip to main content
Skip table of contents

Link to connect to websockets. VMS Client API

This request to get a link to connect to websockets
GET/api/v1/wsurl
Headers
Accept
application/json
X-Client
ios-cctv|android-cctv|thick-legal|web
X-UUID
unique device id
Response
200
Successful response
JSON
{
                "ws_url": "wss://192.168.1.167/ws",
                "app_key": "key",
                "port": 443,
                "host": "192.168.1.167",
                "path": "/ws",
                "is_encrypted": true
            }
429
Retries exceeded
JSON
There is a limit of 20 requests per 5 minutes
Example
JSON
curl -k --location --request GET 'https://vms.local/api/v1/wsurl' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.