Skip to main content
Skip table of contents

Link to connect to websockets

Link to connect to websockets

This request is for obtaining a connection link to Websockets.

GET /api/admin/v1/wsurl
200 OK

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
}
401 Unauthorized

Authorization token is not provided or is invalid

429 Too Many Requests

The number of attempts has exceeded the limit

There is a restriction of 20 requests per 5 minutes
cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/wsurl' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '[]'
PHP
PHP
$data = array (
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/wsurl', false, $context);
JavaScript errors detected

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

If this problem persists, please contact our support.