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()

パラメータ

パラメータ 型 説明
uuid string デバイスの汎用一意識別子（UUIDv7）。deviceid と一致します。
force boolean 「デバイスが見つかりません」エラーを無視してデバイスを強制的に削除するには、true に設定します。

デフォルト: false

戻り値

削除されたデバイスのUUIDを含むオブジェクトを返します。

例

デバイスの削除

指定した UUID のデバイスを削除し、「Device not found」エラーを無視します。

リクエスト:

{
    "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
}