device.get

Este método permite recuperar dispositivos móveis para uso 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 recuperar seus próprios dispositivos.

Assinatura do método: integer/array device.get(object parameters)

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

Parâmetros

Parâmetro Tipo Descrição
deviceids ID/array Retorna somente os dispositivos com os IDs de dispositivo fornecidos.
userids ID/array Retorna somente os dispositivos pertencentes aos usuários com os IDs de usuário fornecidos.
roleids ID/array Retorna somente os dispositivos pertencentes aos usuários com os IDs de função de usuário fornecidos.
usrgrpids ID/array Retorna somente os dispositivos pertencentes aos usuários com os IDs de grupo de usuários fornecidos.
sortfield string/array Ordena o resultado pelas propriedades fornecidas.

Valores possíveis: deviceid, name.
countOutput boolean Esses parâmetros são descritos no comentário de referência.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

Retorna uma matriz de objetos ou a quantidade de objetos recuperados (se countOutput for usado).

Exemplos

Recuperar dispositivos

Recupere os dispositivos pertencentes aos usuários com estes IDs de usuário: 1, 2, 3.
Observe que o usuário 2 (convidado) não possui dispositivos, e o dispositivo 3 ainda não foi adicionado nem autenticado no aplicativo móvel do Zabbix.

Solicitação:

{
    "jsonrpc": "2.0",
    "method": "device.get",
    "params": {
        "output": "extend",
        "userids": [1, 2, 3]
    },
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "deviceid": "1",
            "userid": "1",
            "uuid": "019f930e-0ea2-7c1f-9dcc-0fbb60c40664",
            "name": "Google Pixel 10",
            "status": "1",
            "activated_at": "1784533122",
            "lastaccess": "1784879933"
        },
        {
            "deviceid": "2",
            "userid": "1",
            "uuid": "019d00fb-9e87-7ad5-bb4e-978467254aff",
            "name": "Apple iPhone 15 Pro",
            "status": "1",
            "activated_at": "1784533225",
            "lastaccess": "0"
        },
        {
            "deviceid": "3",
            "userid": "3",
            "uuid": "019d00fb-9e87-7ad5-bb4e-6ed88a2297ee",
            "name": "",
            "status": "0",
            "activated_at": "0",
            "lastaccess": "0"
        }
    ],
    "id": 1
}