device.offboard

Cette méthode permet de supprimer (désenregistrer) des appareils mobiles utilisés avec l'application mobile Zabbix.

La méthode est disponible pour les utilisateurs de type Utilisateur, Administrateur et Super administrateur si EnableMobileDevices est activé et si l'utilisateur a accès aux appareils. L'accès aux méthodes de l'API peut être révoqué dans la configuration du rôle utilisateur.

Les utilisateurs de type Utilisateur et Administrateur peuvent uniquement supprimer leurs propres appareils.

Signature de la méthode : object device.offboard(object parameters)

Source de la méthode : CDevice::offboard() dans ui/include/classes/api/services/CDevice.php

Paramètres

Parameter Type Description
uuid string Identifiant universel unique du périphérique (UUIDv7). Correspond à deviceid.
force boolean Définissez true pour ignorer l’erreur « Périphérique introuvable » et supprimer de force le périphérique.

Valeur par défaut : false

Valeurs de retour

Renvoie un objet contenant l’UUID du périphérique supprimé.

Exemples

Supprimer un appareil

Supprime un appareil avec l'UUID indiqué, en ignorant l'erreur « Appareil introuvable ».

Requête :

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

Réponse :

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