Skip to main content
Skip table of contents

List of servers

Returns a list of servers.

GET /client_api/servers/
Body
searchrequired
string

Search by server name or IP address.

orderingrequired
string

Sort by name or IP. Default is sort by name in ascending order. Sort in descending order: -ip OR -name

Response
200

Returns a JSON array of objects with information about the servers

JSON
[{
            "id": 2,
            "name": "Server 1",
            "ip": "188.343.33.55",
            "port": 8081,
            "binary": [
                {
                    "id": 5,
                    "binary_type": "licplate-recognition",
                    "streams": [
                        {
                            "id": 4,
                            "job_uid": "27b0b1cd-1713-11ed-9820-7478270bd33e",
                            "platform_json": {"key":"value"},
                            "binary_json": {"key":"value"},
                            "status": 5,
                            "stream_uid": "55557b9f-327d-11ec-8f46-dc41a97a0ad6",
                            "camera_group_uid": null,
                            "created_at": "2022-08-08T12:11:18.330615Z",
                            "updated_at": "2022-08-08T12:11:18.330615Z"
                        }
                    ],
                    "status": 2,
                    "options": "Options",
                    "uid": "671b9e46-14b9-11ed-8914-7478270bd33e",
                    "executable_path": "/api/executable_instances/",
                    "config_file_path": "/opt/video-analytics/",
                    "additional_params": "Additional params"
                }
            ]
        }]
string
name

Server name.

string
ip

Server IP address.

int
port

Port.

array
binary

Array of executable files on the server and information about them.

array
binary.streams

Array of streams of the executable file and information about them.

JavaScript errors detected

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

If this problem persists, please contact our support.