Skip to main content
Skip table of contents

View media server

View media server

GET /api/admin/v1/servers/{server}

Method parameters

int server, unique identifier of the media server

200 OK

Successful response

JSON
{
    "id": 59,
    "type": "media_server_v2",
    "schema": "https",
    "internal_domain": "host-name-1.vms.local",
    "external_domain": "host-name-1.vms.local",
    "domain": "host-name-1.vms.local",
    "internal": "8080",
    "external": "8443",
    "m4f": "8443",
    "rtsp": "5554",
    "traffic_in": 70337,
    "traffic_out": 155545,
    "status": true,
    "is_enabled": false,
    "has_cache": null,
    "proxy": "mediaserver1.vms.local",
    "created_at": "2022-01-27 17:16:16",
    "updated_at": "2022-05-26 14:00:02",
    "group_type": "all",
    "can_delete": false,
    "streams_limit": 1000,
    "bitrate_limit": 1000000,
    "extra": {
        "io": {
            "read_rate": 0,
            "read_bytes": 0,
            "write_rate": 0,
            "write_bytes": 0
        },
        "cpu": {
            "total": 23,
            "usage": 24,
            "stime_sec": 15791,
            "utime_sec": 15791
        },
        "mem": {
            "rss": 1596743680,
            "share": 9531392,
            "usage": 3832037376
        },
        "net": {
            "in_bitrate": 72025216,
            "out_bitrate": 159278064
        },
        "drives": {
            "/": {
                "fs": "ext4",
                "mount": "/",
                "inode_free": 3151729,
                "inode_total": 3276800,
                "capacity_free": 41614155776,
                "capacity_total": 52572946432
            },
            "none": {
                "fs": "swap",
                "mount": "none",
                "inode_free": 0,
                "inode_total": 0,
                "capacity_free": 0,
                "capacity_total": 0
            },
            "/storage": {
                "fs": "ext4",
                "mount": "/storage",
                "inode_free": 503158053,
                "inode_total": 503316480,
                "capacity_free": 10360414679040,
                "capacity_total": 16361548312576
            }
        },
        "server": {
            "ip4": "192.168.200.6",
            "name": "MS-21.03-lts",
            "build": "b49af42",
            "uptime": 82750,
            "startat": 1653480052,
            "version": "21.03",
            "hostname": "mediaserver1.vms.local",
            "revision": "lts",
            "timestamp": "20220418080030"
        },
        "cluster": {
            "id": "100",
            "node": "101",
            "enable": "true",
            "hostname": "mediaserver1.vms.local"
        },
        "license": {
            "own": "Vms",
            "type": "enterprise",
            "issued": 1685098802
        },
        "streams": {
            "total": 35,
            "active": 29,
            "clients": 58
        },
        "storages": {
            "/storage": {
                "fs": "",
                "err": 0,
                "name": "default",
                "mount": "/storage",
                "inode_free": 503158053,
                "inode_total": 503316480,
                "capacity_free": 10360414679040,
                "capacity_total": 16361548312576
            },
            "/storage2": {
                "fs": "",
                "err": -2,
                "name": "secondary",
                "mount": "/storage2",
                "inode_free": 0,
                "inode_total": 0,
                "capacity_free": 0,
                "capacity_total": 0
            }
        }
    },
    "storages": [
        {
            "id": 13,
            "server_id": 59,
            "path": "/storage",
            "usage": "36.678",
            "is_confirmed": 1,
            "can_delete": false,
            "created_at": "2022-01-27 19:25:38",
            "updated_at": "2022-05-26 14:00:02"
        }
    ],
    "cluster": {
        "id": 48,
        "name": "cluster name",
        "type": "main_secondary",
        "internal": null,
        "external": null,
        "m4f": null,
        "rtsp": null,
        "publish": null,
        "streams_limit": null,
        "bitrate_limit": null,
        "created_at": "2020-05-15 01:07:44",
        "updated_at": "2020-05-15 01:07:44",
        "pack": {
            "id": 20,
            "name": "pack name",
            "parent_id": null,
            "created_at": "2020-06-30 00:10:55",
            "updated_at": "2020-06-30 00:10:55"
        }
    },
    "is_have_incorrect_cameras": true
}

401 Unauthorized

Authorization token is not provided or is invalid. Obtaining a token

cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/servers/{server}' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "server": 0
}'
PHP
PHP
$data = array (
  'server' => 0,
);
$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/servers/{server}', false, $context);
JavaScript errors detected

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

If this problem persists, please contact our support.