device.offboard

Este método permite remover dispositivos móveis para que deixem de ser usados com o aplicativo móvel do Zabbix.

O método está disponível para usuários User, Admin e Super admin se EnableMobileDevices estiver habilitado e o usuário tiver acesso aos dispositivos. O acesso aos métodos da API pode ser revogado na configuração da função de usuário.

Usuários User e Admin só podem remover seus próprios dispositivos.

Assinatura do método: object device.offboard(object parameters)

Origem do método: CDevice::offboard() em ui/include/classes/api/services/CDevice.php

Parâmetros

Parâmetro Tipo Descrição
uuid string Identificador universalmente exclusivo do dispositivo (UUIDv7). Corresponde a deviceid.
force boolean Defina como true para ignorar o erro "Dispositivo não encontrado" e remover o dispositivo à força.

Padrão: false

Valores de retorno

Retorna um objeto contendo o UUID do dispositivo removido.

Exemplos

Remover dispositivo

Remove um dispositivo com o UUID especificado, ignorando o erro "Dispositivo não encontrado".

Solicitação:

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

Resposta:

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