device.offboard

This method allows you to remove (offboard) mobile devices for use with Zabbix mobile app.

The method is available to User, Admin, and Super admin users if EnableMobileDevices is enabled and the user has access to devices. Access to API methods can be revoked in user role configuration.

User and Admin users can only remove their own devices.

Method signature: object device.offboard(object parameters)

Method source: CDevice::offboard() in ui/include/classes/api/services/CDevice.php

Parameters

Parameter Type Description
uuid string Device universally unique identifier (UUIDv7). Matches deviceid.
force boolean Set true to ignore the "Device not found" error and forcibly remove the device.

Default: false

Return values

Returns an object containing the UUID of the removed device.

Examples

Remove device

Remove a device with the given UUID, ignoring the "Device not found" error.

Request:

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

Response:

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