device.offboard

此方法允许移除(取消注册)用于 Zabbix 移动应用 的移动设备。

如果启用了 EnableMobileDevices,且用户拥有设备访问权限,则 User、Admin 和 Super admin 用户可以使用此方法。 可以在用户角色配置中撤销对 API 方法的访问权限。

User 和 Admin 用户只能移除自己的设备。

方法签名:object device.offboard(object parameters)

方法源代码:ui/include/classes/api/services/CDevice.php 中的 CDevice::offboard()

参数

Parameter Type Description
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
}