device.offboard

Этот метод позволяет удалить (вывести из эксплуатации) мобильные устройства, используемые с мобильным приложением Zabbix.

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

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

Сигнатура метода: object device.offboard(object parameters)

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

Параметры

Параметр Тип Описание
uuid string Универсальный уникальный идентификатор устройства (UUIDv7). Соответствует deviceid.
force boolean Установите значение true, чтобы игнорировать ошибку «Устройство не найдено» и принудительно удалить устройство.

По умолчанию: false

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

Возвращает объект, содержащий UUID удалённого устройства.

Примеры

Удаление устройства

Удаляет устройство с указанным UUID, игнорируя ошибку «Устройство не найдено».

Запрос:

{
    "jsonrpc": "2.0",
    "method": "device.offboard",
    "params": {
        "uuid": "019d0106-5eef-7154-a159-bb29e35d38e5",
        "force": true
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "uuid": "019d0106-5eef-7154-a159-bb29e35d38e5"
    },
    "id": 1
}