> For the complete documentation index, see [llms.txt](https://portal-integracao.intelbras.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://portal-integracao.intelbras.com.br/api-inc-cloud/dispositivos.md).
# Dispositivos
Operações com dispositivos e status de hardware
## Obter lista paginada de dispositivos do usuário
> Retorna os dispositivos do usuário de forma paginada (\`start\`/\`size\`), com filtros opcionais por número de série, site, status, modelo e tipo de dispositivo.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/shop/device/page":{"post":{"tags":["Dispositivos"],"summary":"Obter lista paginada de dispositivos do usuário","parameters":[{"name":"user_name","in":"query","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","required":true,"description":"Idioma da resposta. Envie `en` para receber textos em inglês.","schema":{"type":"string","enum":["en"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"integer","description":"Página inicial (1-based)."},"size":{"type":"integer","description":"Quantidade de itens por página."},"devSn":{"type":"string","description":"Filtro por número de série do dispositivo. Deixe vazio para não filtrar."},"shopName":{"type":"string","description":"Filtro por nome do site. Deixe vazio para não filtrar."},"status":{"type":"integer","nullable":true,"description":"Filtro por status do dispositivo (null para não filtrar)."},"devModel":{"type":"string","description":"Filtro por modelo do dispositivo. Deixe vazio para não filtrar."},"customType":{"type":"string","description":"Filtro por tipo de dispositivo (ex. switch, ap, ac). Deixe vazio para não filtrar."},"orderby":{"type":"string","description":"Campo usado para ordenação dos resultados. Deixe vazio para não filtrar."},"ascending":{"type":"boolean","description":"Ordenação ascendente (true) ou descendente (false)."},"userIdList":{"type":"array","description":"Lista de IDs de usuário para filtrar dispositivos.","items":{"type":"integer"}}},"required":["start","size"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"rowCount":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"shopId":{"type":"integer"},"shopName":{"type":"string"},"customType":{"type":"string"},"devModel":{"type":"string"},"devSn":{"type":"string"},"status":{"type":"integer"},"onlineTime":{"type":"integer"},"firstOnlineTime":{"type":"integer"},"aliasName":{"type":"string"},"devType":{"type":"string"}}}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"Retorna os dispositivos do usuário de forma paginada (`start`/`size`), com filtros opcionais por número de série, site, status, modelo e tipo de dispositivo.","operationId":"listDevices"}}}}
```
## Obter lista paginada de dispositivos de uma região
> Retorna os dispositivos cadastrados em uma região (\`regionId\`), com suporte a paginação,\
> ordenação e filtros por alias, número de série, modelo, status e tipo de dispositivo.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/regiondevices1":{"post":{"tags":["Dispositivos"],"summary":"Obter lista paginada de dispositivos de uma região","description":"Retorna os dispositivos cadastrados em uma região (`regionId`), com suporte a paginação,\nordenação e filtros por alias, número de série, modelo, status e tipo de dispositivo.\n","parameters":[{"name":"user_name","in":"query","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","required":true,"description":"Idioma da resposta. Envie `en` para receber textos em inglês.","schema":{"type":"string","enum":["en"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"type":"integer","description":"Identificador da região a ser consultada."},"start":{"type":"integer","description":"Página inicial (1-based)."},"size":{"type":"integer","description":"Quantidade de itens por página."},"orderby":{"type":"string","description":"Campo usado para ordenação dos resultados."},"ascending":{"type":"boolean"},"status":{"type":"integer","nullable":true,"description":"Filtro por status do dispositivo (`null` para não filtrar)."},"devAlias":{"type":"string","description":"Filtro por apelido do dispositivo. Deixe vazio para não filtrar."},"devSn":{"type":"string","description":"Filtro por número de série do dispositivo. Deixe vazio para não filtrar."},"devModel":{"type":"string","description":"Filtro por modelo do dispositivo. Deixe vazio para não filtrar."},"devDesc":{"type":"string","description":"Filtro por descrição do dispositivo. Deixe vazio para não filtrar."},"customTypeStrList":{"type":"array","description":"Tipos de dispositivo a serem incluídos no resultado.","items":{"type":"string"}}},"required":["regionId"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"rowCount":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"regionId":{"type":"integer"},"regionName":{"type":"string"},"shopId":{"type":"integer"},"shopName":{"type":"string"},"deviceId":{"type":"integer"},"devAlias":{"type":"string"},"customType":{"type":"string"},"customTypeStr":{"type":"string"},"devModel":{"type":"string"},"devType":{"type":"integer","description":"0 = dispositivo cabeado (switch), 1 = dispositivo com rádio."},"devSn":{"type":"string"},"macAddr":{"type":"string"},"status":{"type":"integer","description":"0 = online, 1 = offline."},"softVer":{"type":"string"},"hardVer":{"type":"string"},"devIp":{"type":"string"},"groupId":{"type":"integer"},"groupName":{"type":"string"},"addTime":{"type":"integer","description":"Timestamp (ms) de cadastro do dispositivo."},"addTimeStr":{"type":"string"},"firstOnlineTime":{"type":"integer"},"firstOnlineTimeStr":{"type":"string"},"onlineTime":{"type":"integer"},"onlineTimeStr":{"type":"string"},"offlineTime":{"type":"integer"},"offlineTimeStr":{"type":"string"},"wifiStatus":{"type":"string"},"url":{"type":"string","description":"Link para a tela de detalhes do dispositivo no portal. O trecho `{shopId}` deve ser substituído pelo ID do site."}}}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"listRegionDevices"}}}}
```
## Obter informações de AP
> Retorna as informações de um ponto de acesso (AP), como modelo, endereços e estado.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/device/apinfo":{"get":{"tags":["Dispositivos"],"summary":"Obter informações de AP","parameters":[{"name":"devsn","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"apSN":{"type":"string"},"apModel":{"type":"string"},"apName":{"type":"string"},"apIp":{"type":"string"},"apSoftVersion":{"type":"string"},"apStatus":{"type":"integer"},"apOnlineTime":{"type":"integer"},"apMAC":{"type":"string"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"Retorna as informações de um ponto de acesso (AP), como modelo, endereços e estado.","operationId":"getApInfo"}}}}
```
## Obter informações de rádio do dispositivo
> Retorna informações detalhadas dos rádios associados ao dispositivo identificado.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/device/radioinfo":{"get":{"tags":["Dispositivos"],"summary":"Obter informações de rádio do dispositivo","description":"Retorna informações detalhadas dos rádios associados ao dispositivo identificado.","parameters":[{"name":"devsn","in":"query","required":true,"description":"Número de série do dispositivo.","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"apSN":{"type":"string","description":"Número de série do Access Point."},"apName":{"type":"string","description":"Nome do Access Point."},"devSN":{"type":"string","description":"Número de série do dispositivo."},"radioId":{"type":"integer","description":"Identificador do rádio"},"radioMode":{"type":"string","description":"Modo do rádio","nullable":true},"radioChannel":{"type":"integer","description":"Canal utilizado pelo rádio.","nullable":true},"radioPower":{"type":"integer","description":"Potência de transmissão em dBm.","nullable":true}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getRadioInfo"}}}}
```
## Obter informações de SSID
> Retorna os SSIDs configurados no dispositivo informado.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/device/ssidinfo":{"get":{"tags":["Dispositivos"],"summary":"Obter informações de SSID","parameters":[{"name":"devsn","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"maxReceiveRatio":{"type":"integer"},"maxSendRatio":{"type":"integer"},"status":{"type":"integer"},"devSN":{"type":"string"},"SSIDName":{"type":"string"},"maxClient":{"type":"integer"},"spName":{"type":"string"},"hide":{"type":"integer"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"Retorna os SSIDs configurados no dispositivo informado.","operationId":"getSsidInfo"}}}}
```
## Obter endereços MAC de clientes por SSID
> Obter endereços MAC de clientes por SSID\
> Limite: 1 vez/segundo
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/device/ssid/clientmac":{"post":{"tags":["Dispositivos"],"summary":"Obter endereços MAC de clientes por SSID","description":"Obter endereços MAC de clientes por SSID\nLimite: 1 vez/segundo\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","description":"Método de solicitação","enum":["getClientMacbySsid"]},"param":{"type":"object","description":"Parâmetros de solicitação","properties":{"shopId":{"type":"string","description":"ID do site"},"devSN":{"type":"string","description":"Número de série do dispositivo"},"SSID":{"type":"string","description":"SSID"}},"required":["shopId","devSN","SSID"]}},"required":["method","param"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","description":"Lista de endereços MAC de clientes","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"listClientMacsBySsid"}}}}
```
## Obter histórico de clientes associados a um dispositivo
> Retorna o histórico de clientes que se conectaram ao dispositivo informado, com paginação por \`skipnum\`/\`limitnum\`.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/device/historyclients":{"post":{"tags":["Dispositivos"],"summary":"Obter histórico de clientes associados a um dispositivo","parameters":[{"name":"devSN","in":"query","required":true,"schema":{"type":"string"}},{"name":"skipnum","in":"query","required":true,"schema":{"type":"integer"}},{"name":"limitnum","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"count_total":{"type":"integer"},"count_left":{"type":"integer"},"histClientList":{"type":"array","items":{"type":"object","properties":{"macAddr":{"type":"string"},"ApName":{"type":"string"},"clientMAC":{"type":"string"},"clientIP":{"type":"string"},"clientVendor":{"type":"string"},"clientSSID":{"type":"string"},"onlineTime":{"type":"integer"},"onLineDate":{"type":"string","format":"date-time"},"offLineDate":{"type":"string","nullable":true}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"Retorna o histórico de clientes que se conectaram ao dispositivo informado, com paginação por `skipnum`/`limitnum`.","operationId":"listDeviceClientHistory"}}}}
```
## Obter informações detalhadas sobre clientes online
> Obter informações detalhadas sobre clientes online\
> Limite: 1 vez/segundo
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/device/onlineclients":{"post":{"tags":["Dispositivos"],"summary":"Obter informações detalhadas sobre clientes online","description":"Obter informações detalhadas sobre clientes online\nLimite: 1 vez/segundo\n","parameters":[{"name":"devSN","in":"query","required":true,"schema":{"type":"string"},"description":"Número de série do dispositivo (AC/Controller)"},{"name":"skipnum","in":"query","required":false,"schema":{"type":"integer","default":0},"description":"Número de registros a pular (para paginação)"},{"name":"limitnum","in":"query","required":false,"schema":{"type":"integer","default":10},"description":"Número máximo de registros a retornar (para paginação)"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"findoption":{"type":"object","description":"Campos pelos quais as informações exibidas são filtradas","properties":{"ApName":{"type":"string","description":"Nome do AP para filtrar"},"clientMAC":{"type":"string","description":"Endereço MAC do cliente para filtrar"},"clientSSID":{"type":"string","description":"SSID para filtrar"}}},"sortoption":{"type":"object","description":"Campos pelos quais as informações exibidas são classificadas","properties":{"onlineTime":{"type":"integer","enum":[1,-1],"description":"Ordenar por tempo online (1 = ascendente, -1 = descendente)"},"clientTxRate":{"type":"integer","enum":[1,-1],"description":"Ordenar por taxa de transmissão (1 = ascendente, -1 = descendente)"},"signalStrength":{"type":"integer","enum":[1,-1],"description":"Ordenar por força do sinal (1 = ascendente, -1 = descendente)"}}}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"clientList":{"type":"object","properties":{"count_left":{"type":"integer","description":"Número de clientes restantes"},"count_total":{"type":"integer","description":"Número total de clientes"},"clientInfo":{"type":"array","items":{"type":"object","properties":{"upLineTime":{"type":"string","format":"date-time","description":"Data e hora quando o cliente ficou online"},"acSN":{"type":"string","description":"Número de série do controlador"},"clientMAC":{"type":"string","description":"Endereço MAC do cliente"},"apSN":{"type":"string","description":"Número de série do AP"},"clientIP":{"type":"string","description":"Endereço IP do cliente"},"ApName":{"type":"string","description":"Nome do Access Point"},"clientTxRate":{"type":"number","format":"float","description":"Taxa de transmissão do cliente (Mbps)"},"clientRxRate":{"type":"number","format":"float","description":"Taxa de recepção do cliente (Mbps)"},"clientName":{"type":"string","description":"Nome do cliente"},"clientSSID":{"type":"string","description":"SSID da rede WiFi"},"signalStrength":{"type":"integer","description":"Força do sinal em dBm"},"clientRadioMode":{"type":"integer","description":"Modo de rádio do cliente"},"clientMode":{"type":"string","description":"Modo do cliente (802.11gn, 802.11ac, etc.)"},"clientChannel":{"type":"integer","description":"Canal WiFi utilizado"},"clientTxBytes":{"type":"integer","description":"Bytes transmitidos"},"clientRxBytes":{"type":"integer","description":"Bytes recebidos"},"clientTxPackets":{"type":"integer","description":"Pacotes transmitidos"},"clientRxPackets":{"type":"integer","description":"Pacotes recebidos"},"NegoMaxRate":{"type":"number","format":"float","description":"Taxa máxima negociada (Mbps)"},"portalUserName":{"type":"string","description":"Nome de usuário do portal"},"CU":{"type":"string","nullable":true,"description":"Utilização do canal"},"onlineTime":{"type":"number","format":"float","description":"Tempo online em segundos"},"clientVendor":{"type":"string","description":"Fabricante do dispositivo cliente"},"portalAuthType":{"type":"string","description":"Tipo de autenticação do portal"},"apMac":{"type":"string","description":"Endereço MAC do AP"}}}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"listDeviceOnlineClients"}}}}
```
## Obter estatísticas de tráfego e taxas de clientes
> Retorna o tráfego (upload/download, em Kb) e as taxas (em Kbps) das interfaces do dispositivo no período informado.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/device/interfaceflow":{"post":{"tags":["Dispositivos"],"summary":"Obter estatísticas de tráfego e taxas de clientes","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string"},"devSN":{"type":"string"},"startTime":{"type":"integer","description":"Hora de início em milissegundos"},"endTime":{"type":"integer","description":"Hora de término em milissegundos"}},"required":["method","devSN","startTime","endTime"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"upflow":{"type":"integer","description":"Tráfego carregado, em Kb"},"downflow":{"type":"integer","description":"Tráfego baixado, em Kb"},"speedUp":{"type":"integer","description":"Velocidade do uplink, em Kbps"},"speedDown":{"type":"integer","description":"Velocidade de downlink, em Kbps"},"devSN":{"type":"string","description":"Número de série do dispositivo"},"updateTime":{"type":"string","format":"date-time","description":"Hora da atualização no formato UTC"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"Retorna o tráfego (upload/download, em Kb) e as taxas (em Kbps) das interfaces do dispositivo no período informado.","operationId":"getInterfaceFlow"}}}}
```
## Obter informações de GPS do AP por devSN
> Retorna dados de geolocalização em tempo real do access point
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/device/apgps":{"get":{"tags":["Dispositivos"],"summary":"Obter informações de GPS do AP por devSN","description":"Retorna dados de geolocalização em tempo real do access point","operationId":"getApGps","parameters":[{"name":"devsn","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Dados GPS obtidos com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"apSN":{"type":"string"},"apName":{"type":"string"},"apLongitude":{"type":"string","description":"Valor em graus decimais (WGS84)"},"apLatitude":{"type":"string","description":"Valor em graus decimais (WGS84)"},"apVelocity":{"type":"string","description":"Velocidade em km/h"},"apOrientation":{"type":"string","description":"Angulo em graus (0=Norte)"},"apElevation":{"type":"string","description":"Altitude em metros"},"gpsObtainTime":{"type":"string","description":"UTC timestamp da ultima atualizacao"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}}}}
```
## Obter nós da topologia de rede de um site
> Retorna os nós (switches, APs, estações etc.) da topologia de rede do site informado.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/common/topo/nodes":{"get":{"tags":["Dispositivos"],"summary":"Obter nós da topologia de rede de um site","description":"Retorna os nós (switches, APs, estações etc.) da topologia de rede do site informado.\n","parameters":[{"name":"user_name","in":"query","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","required":true,"description":"Idioma da resposta. Envie `en` para receber textos em inglês.","schema":{"type":"string","enum":["en"]}},{"name":"shopId","in":"query","required":true,"description":"Identificador do site.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"shopId":{"type":"integer"},"identity":{"type":"integer","description":"Identificador interno do dispositivo (equivale ao `srcId`/`desId` em `/common/topo/links`)."},"updateDate":{"type":"integer","description":"Timestamp (ms) da última atualização da topologia."},"nodeType":{"type":"integer","description":"Tipo do nó (0 = dispositivo gerenciado, 1 = dispositivo não gerenciado/detectado)."},"name":{"type":"string","nullable":true},"sn":{"type":"string","nullable":true},"mac":{"type":"string","nullable":true},"type":{"type":"string","nullable":true,"description":"Tipo do dispositivo."},"model":{"type":"string","nullable":true},"version":{"type":"string","nullable":true},"onlineStatus":{"type":"integer","description":"0 = offline, 1 = online."},"autoGenerated":{"type":"integer"},"hidden":{"type":"integer"},"hiddenCause":{"type":"integer"},"isDeleted":{"type":"integer"},"manageIp":{"type":"string","nullable":true},"ipv4AddressList":{"type":"array","nullable":true,"items":{"type":"object","properties":{"ifIndex":{"type":"integer"},"ipv4Address":{"type":"string"},"ipv4Mask":{"type":"string"},"addressOrigin":{"type":"integer"},"ifName":{"type":"string"}}}},"wlanAccessPoint":{"type":"boolean"},"lldpFlag":{"type":"boolean"},"interfaceFlag":{"type":"boolean"},"enabledLldp":{"type":"boolean"},"laggGroupId":{"type":"object","nullable":true,"description":"Mapa `grupo de agregação -> ifIndex`.","additionalProperties":{"type":"integer"}},"laggMembers":{"type":"object","nullable":true,"description":"Mapa `grupo de agregação -> lista de ifIndex membros`.","additionalProperties":{"type":"array","items":{"type":"integer"}}},"vlanIfNames":{"type":"object","nullable":true,"description":"Mapa `nome da interface -> VLANs associadas`.","additionalProperties":{"type":"string"}},"portInfo":{"type":"object","nullable":true,"description":"Mapa `porta -> informações da porta`.","additionalProperties":{"type":"object","properties":{"ifName":{"type":"string"},"ifIndex":{"type":"integer"},"actualSpeed":{"type":"string"},"actualDuplex":{"type":"string"},"linkType":{"type":"string"},"description":{"type":"string"},"vlan":{"type":"string","nullable":true},"operStatus":{"type":"integer"},"inetAddressIPV4":{"type":"string","nullable":true},"groupMembers":{"nullable":true}}}}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"listTopologyNodes"}}}}
```
## Obter enlaces (links) da topologia de rede de um site
> Retorna as conexões entre os nós da topologia de rede do site informado (ver \`/common/topo/nodes\`).
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/common/topo/links":{"get":{"tags":["Dispositivos"],"summary":"Obter enlaces (links) da topologia de rede de um site","description":"Retorna as conexões entre os nós da topologia de rede do site informado (ver `/common/topo/nodes`).\n","parameters":[{"name":"user_name","in":"query","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","required":true,"description":"Idioma da resposta. Envie `en` para receber textos em inglês.","schema":{"type":"string","enum":["en"]}},{"name":"shopId","in":"query","required":true,"description":"Identificador do site.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"shopId":{"type":"integer"},"updateDate":{"type":"integer","description":"Timestamp (ms) da última atualização da topologia."},"links":{"type":"array","items":{"type":"object","properties":{"status":{"type":"integer"},"srcId":{"type":"integer","description":"Identificador do nó de origem (`identity` em `/common/topo/nodes`)."},"srcPort":{"type":"string","nullable":true},"desId":{"type":"integer","nullable":true,"description":"Identificador do nó de destino (`identity` em `/common/topo/nodes`)."},"desPort":{"type":"string","nullable":true}}}},"rootsUpPorts":{"type":"array","items":{"type":"object","properties":{"rootId":{"type":"integer"},"portName":{"type":"string"},"ifIndex":{"type":"integer"}}}},"status":{"type":"integer"},"count":{"type":"integer"},"topoLogs":{"type":"array","items":{"type":"object"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"listTopologyLinks"}}}}
```
## Reiniciar um dispositivo
> Realiza o reboot de um dispositivo identificado pelo número de série. Opcionalmente salva a\
> configuração atual antes de reiniciar.\
> \
> Ação irreversível: o dispositivo fica indisponível durante o reboot. Use com cuidado\
> em dispositivos de produção.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/base/resetDev":{"post":{"tags":["Dispositivos"],"summary":"Reiniciar um dispositivo","description":"Realiza o reboot de um dispositivo identificado pelo número de série. Opcionalmente salva a\nconfiguração atual antes de reiniciar.\n\nAção irreversível: o dispositivo fica indisponível durante o reboot. Use com cuidado\nem dispositivos de produção.\n","parameters":[{"name":"user_name","in":"query","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","required":true,"description":"Idioma da resposta. Envie `en` para receber textos em inglês.","schema":{"type":"string","enum":["en"]}}],"requestBody":{"required":true,"description":"`saveConfig`: 1 = realiza o reboot e salva as configurações. 0 = apenas realiza o reboot, sem salvar.\n","content":{"application/json":{"schema":{"type":"object","properties":{"devSN":{"type":"string","description":"Número de série do dispositivo a ser reiniciado."},"saveConfig":{"type":"integer","description":"1: realiza o reboot e salva as configurações.\n0: apenas realiza o reboot, sem salvar.\n","enum":[0,1]}},"required":["devSN","saveConfig"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"rebootDevice"}}}}
```
## Obter informações básicas de manutenção de um Cloud AP
> Retorna informações operacionais detalhadas de um Cloud AP específico (versões, IPs, CPU/memória,\
> canais e potência de rádio, clientes conectados, status de configuração etc.), usadas em telas de\
> diagnóstico/manutenção.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Dispositivos","description":"Operações com dispositivos e status de hardware"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/apmonitor/maintain/getCloudApBasicInfo":{"post":{"tags":["Dispositivos"],"summary":"Obter informações básicas de manutenção de um Cloud AP","description":"Retorna informações operacionais detalhadas de um Cloud AP específico (versões, IPs, CPU/memória,\ncanais e potência de rádio, clientes conectados, status de configuração etc.), usadas em telas de\ndiagnóstico/manutenção.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shopId":{"type":"string","description":"Identificador do site."},"apSN":{"type":"string","description":"Número de série do AP."},"user":{"type":"string","description":"Nome de usuário autenticado."}},"required":["shopId","apSN","user"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"shopId":{"type":"string"},"shopName":{"type":"string"},"acSN":{"type":"string","description":"Número de série do AC controlador (`-` quando não gerenciado por um)."},"acName":{"type":"string"},"apName":{"type":"string"},"apSN":{"type":"string"},"Md":{"type":"string","description":"Modelo do dispositivo."},"HV":{"type":"string","description":"Versão de hardware."},"SV":{"type":"string","description":"Versão de software."},"MAC":{"type":"string"},"OLT":{"type":"string","format":"date-time","description":"Online time (última vez que ficou online)."},"OFT":{"type":"string","format":"date-time","description":"Offline time (última vez que ficou offline)."},"CPU":{"type":"integer","description":"Uso de CPU (%)."},"MEM":{"type":"integer","description":"Uso de memória (%)."},"staCount":{"type":"integer","description":"Quantidade de clientes conectados."},"WTC":{"type":"string","description":"Status do WiFi Tracking (retornado pela API em chinês, ex.: 废弃 = descontinuado)."},"IP4":{"type":"string","description":"IP local (IPv4)."},"PubIP":{"type":"string","description":"IP público."},"BT":{"type":"string","format":"date-time","description":"Boot time (última inicialização)."},"Ss":{"type":"integer","description":"Status do dispositivo (0 = offline, 1 = online)."},"chArr":{"type":"array","description":"Canais de rádio por interface (`-` quando não aplicável).","items":{"type":"string"}},"pwArr":{"type":"array","description":"Potência de transmissão por interface (`-` quando não aplicável).","items":{"type":"string"}},"ccbArr":{"type":"array","description":"Utilização de canal por interface (`-` quando não aplicável).","items":{"type":"string"}},"OLDuration":{"type":"integer","description":"Duração online, em segundos."},"BTD":{"type":"integer","description":"Duração desde o boot, em segundos."},"ssidArr":{"type":"array","description":"Lista de SSIDs divulgados pelo AP.","items":{"type":"string"}},"confStatus":{"type":"string","description":"Status da última sincronização de configuração."}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getCloudApBasicInfo"}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://portal-integracao.intelbras.com.br/api-inc-cloud/dispositivos.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.