device.offboard

Ta metoda umożliwia usunięcie (wyrejestrowanie) urządzeń mobilnych używanych z aplikacją mobilną Zabbix.

Metoda jest dostępna dla użytkowników typu User, Admin i Super admin, jeśli parametr EnableMobileDevices jest włączony, a użytkownik ma dostęp do urządzeń. Dostęp do metod API można odebrać w konfiguracji roli użytkownika.

Użytkownicy typu User i Admin mogą usuwać tylko własne urządzenia.

Sygnatura metody: object device.offboard(object parameters)

Źródło metody: CDevice::offboard() w pliku ui/include/classes/api/services/CDevice.php

Parametry

Parametr Typ Opis
uuid string Uniwersalny unikatowy identyfikator urządzenia (UUIDv7). Odpowiada deviceid.
force boolean Ustaw true, aby zignorować błąd „Nie znaleziono urządzenia” i wymusić usunięcie urządzenia.

Wartość domyślna: false

Wartości zwracane

Zwraca obiekt zawierający UUID usuniętego urządzenia.

Przykłady

Usuń urządzenie

Usuwa urządzenie o podanym identyfikatorze UUID, ignorując błąd „Nie znaleziono urządzenia”.

Żądanie:

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

Odpowiedź:

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