device.get

Этот метод позволяет получить мобильные устройства для использования с мобильным приложением Zabbix.

Метод доступен пользователям с ролями User, Admin и Super admin, если включен параметр EnableMobileDevices и у пользователя есть доступ к устройствам. Доступ к методам API можно отозвать в настройках роли пользователя.

Пользователи с ролями User и Admin могут получать только собственные устройства.

Сигнатура метода: integer/array device.get(object parameters)

Исходный код метода: CDevice::get() в ui/include/classes/api/services/CDevice.php

Параметры

Параметр Тип Описание
deviceids ID/array Возвращать только устройства с указанными идентификаторами устройств.
userids ID/array Возвращать только устройства, принадлежащие пользователям с указанными идентификаторами пользователей.
roleids ID/array Возвращать только устройства, принадлежащие пользователям с указанными идентификаторами ролей пользователей.
usrgrpids ID/array Возвращать только устройства, принадлежащие пользователям с указанными идентификаторами групп пользователей.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: deviceid, name.
countOutput boolean Эти параметры описаны в справочном комментарии.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Возвращаемые значения

Возвращает либо массив объектов, либо количество полученных объектов (если используется countOutput).

Примеры

Получение устройств

Получение устройств, принадлежащих пользователям со следующими идентификаторами: 1, 2, 3.
Обратите внимание, что у пользователя 2 (гостя) нет устройств, а устройство 3 еще не было добавлено или аутентифицировано в мобильном приложении Zabbix.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "device.get",
    "params": {
        "output": "extend",
        "userids": [1, 2, 3]
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "deviceid": "1",
            "userid": "1",
            "uuid": "019f930e-0ea2-7c1f-9dcc-0fbb60c40664",
            "name": "Google Pixel 10",
            "status": "1",
            "activated_at": "1784533122",
            "lastaccess": "1784879933"
        },
        {
            "deviceid": "2",
            "userid": "1",
            "uuid": "019d00fb-9e87-7ad5-bb4e-978467254aff",
            "name": "Apple iPhone 15 Pro",
            "status": "1",
            "activated_at": "1784533225",
            "lastaccess": "0"
        },
        {
            "deviceid": "3",
            "userid": "3",
            "uuid": "019d00fb-9e87-7ad5-bb4e-6ed88a2297ee",
            "name": "",
            "status": "0",
            "activated_at": "0",
            "lastaccess": "0"
        }
    ],
    "id": 1
}