Get information about a stream: Stream.Get

The method and parameters

The Stream.Get method enables you to retrieve detailed information about streams.

string Stream.Get (array uids)

array uids required – the list of streams which detailed information is requested.

POST /api/

JSON-RPC

JSON

{
    "jsonrpc": "2.0",
    "method": "Stream.Get",
    "params": [
        "uids"
    ],
    "id": 1
}

cURL

Bash

curl -k --request POST \
	--url 'https://your-domain/api/' \
	--header 'Content-Length: 103' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--header 'Authorization: Bearer <api-authorization-token>' \
	--header 'Content-Length: <Content length>' \
	--data '{
    "jsonrpc": "2.0",
    "method": "Stream.Get",
    "params": [
        "uids"
    ],
    "id": 1
}'

PHP

$data = array (
  'jsonrpc' => '2.0',
  'method' => 'Stream.Get',
  'params' => 
  array (
    0 => 'uids',
  ),
  'id' => 1,
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'POST',
		'header' => "Content-Type: application/json\r
Accept: application/json\r
Authorization: Bearer <api-authorization-token>\r
Content-Length: <data length>",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/', false, $context);

200 OK

The list of objects with detailed information about the stream.

JSON

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "camera-uid5065687": {
            "stream-uid5065687": "stream json info object"
        },
        "camera-uid5065688": {
            "stream-uid5065688": "stream json info object"
        }
    }
}

400 Bad Request

The JSON-RPC error

JSON

{
    "error": {
        "code": -32601,
        "message": "Method not found"
    }
}

500 Internal Server Error

The server error