Get the list of analytics engines (ovms)

GET /api/admin/v1/analytic/ovms/handlers

Parameters

int per_page, Number of elements in one pagination page.

int page, Pagination page number

string search, Search is carried out by server name and ip

string sort, Sorting is done by 'name' and 'ip'

string dir, In which direction to sort.

array analytic_regions, Array of analytics regions IDs by which analytics engines will be filtered

200 OK

Successful response

JSON

{
    "data": [
        {
            "id": 17,
            "uuid": "a8e41186-102b-11ee-ad4f-9f6a9e886253",
            "name": "worker-ld3rpd2u",
            "domain": "192.168.205.151",
            "status": "RUNNING",
            "analytic_regions": [
                {
                    "id": 4,
                    "title": "USA"
                },
                {
                    "id": 5,
                    "title": "Brazil"
                }
            ]
        },
        {
            "id": 137,
            "uuid": "53bb8ea8-509c-11ee-8c4f-b5c3d514a8ed",
            "name": "ovms-client-75bc8448c5-8m9rs",
            "domain": "10.244.112.249",
            "status": "RUNNING",
            "analytic_regions": []
        },
        {
            "id": 136,
            "uuid": "9f5d4488-4803-11ee-8c4f-b5c3d514a8ed",
            "name": "ovms-and-worker-6cc8647c6b-5sfdl",
            "domain": "10.244.112.248",
            "status": "RUNNING",
            "analytic_regions": [
                {
                    "id": 3,
                    "title": "Germany"
                }
            ]
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 25,
        "to": 3,
        "total": 4
    }
}

401 Unauthorized

Authorization token not sent or not valid

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/analytic/ovms/handlers' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "per_page": 0,
    "page": 0,
    "search": "string",
    "sort": "string",
    "dir": "string",
    "analytic_regions": []
}'

PHP

$data = array (
  'per_page' => 0,
  'page' => 0,
  'search' => 'string',
  'sort' => 'string',
  'dir' => 'string',
  'analytic_regions' => 
  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/analytic/ovms/handlers', false, $context);