...

APIs públicas CIQ ITAM

Estimativa de leitura: 5 minutos

API pública Collective IQ

Integração e automação simplificadas

O módulo CIQ ITAM Public API fornece APIs para consulta de informações sobre Hardware, Software, Desempenho e muito mais. Ele permite que sistemas externos acessem dados diretamente do CIQ ITAM. Por meio dessa API, é possível automatizar consultas, atualizações e integrações com outras ferramentas de gerenciamento de TI.

Essa funcionalidade é essencial para empresas que buscam aumentar a eficiência do processo, eliminando ações manuais repetitivas e permitindo a criação de fluxos de trabalho personalizados.

Com a API PúblicaCIQ ITAM, sua equipe de TI pode integrar os dados e comandos CIQ ITAM com sistemas como ERPs, plataformas de monitoramento ou scripts internos, otimizando a gestão e promovendo maior agilidade e precisão operacional.

SmartCenter As APIs públicas disponibilizam todos os dados de inventário, bem como a opção de extraí-los em um relatório, entregue no formato JSON.
Ele pode ser usado para integração com ferramentas que fazem chamadas à API REST e aceitam JSON como o tipo de dados de entrega.

imagem 398 APIs públicas CIQ
Menu > Integrações > API pública CIQ

Recursos de consulta

A API pública Collective IQ é baseada em REST e fornece vários pontos finais, cada um segmentado por tipo de dados. Cada segmento abaixo representa uma URL específica, permitindo consultas direcionadas de acordo com o domínio de dados desejado.

As respostas são retornadas no formato JSON, e os campos listados abaixo representam exatamente o que pode ser consultado, independentemente dos valores retornados por cada dispositivo.

Dados de hardware (estações de trabalho)

Terminal dedicado ao inventário de computadores de mesa e notebooks.

Campos de consulta disponíveis:

computer_name; department_name; department_hierarchy; so_string; so_version; system_manufacturer; computer_type; machine_net_ipaddress; bios_release_date; machine_ipdomain; is_virtual_machine; system_product_name; system_serial_number; machine_id; os_bits; login_name; cpu_identity; cpu_generation; cpu_type; cpu_clock; cpu_clock_in_MHz; cpu_clock_in_GHz; core_num; physical_cpu_amount; logical_cpu; memory_range; installed_mem; disk_total; disk_used; top_user; percent_top_user; dns_servers; machine_gateway; collect_date; status; installed_agent_type; installed_agent_version; update_date; last_login; installed_mem_in_GB; disk_total_in_GB; disk_used_in_GB; installed_mem_in_MB; disk_total_in_MB; disk_used_in_MB

Software (estações de trabalho)

Terminal dedicado ao inventário de software instalado nas estações de trabalho.

Campos de consulta disponíveis:

sw_id; computer_name; department_name; software_name; normalized_software_name; is_licensable; software_version; software_manufacturer; homologation_status; instalation_date; machine_type; machine_id; family; label; category_name; category_description; group_name; group_description; register_key

Monitor

Terminal responsável pelas informações relacionadas aos monitores associados às estações de trabalho.

Campos de consulta disponíveis:

machine_id; computer_name; computer_type; collect_time; department_name; so_string; system_serial_number; monitors

Hardware do servidor

Terminal dedicado ao inventário de servidores físicos e virtuais.

Campos de consulta disponíveis:

computer_name; department_name; so_string; so_version; system_manufacturer; computer_type; machine_net_ipaddress; bios_release_date; machine_ipdomain; is_virtual_machine; system_product_name; system_serial_number; machine_id; cpu_identity; cpu_generation; cpu_type; cpu_clock; cpu_clock_in_MHz; cpu_clock_in_GHz; core_num; cpu_quantity; cpu_active; memory_range; installed_mem; disk_total; disk_used; collect_date; status; installed_agent_type; installed_agent_version; update_date; installed_mem_in_GB; disk_total_in_GB; disk_used_in_GB; installed_mem_in_MB; disk_total_in_MB; disk_used_in_MB; os_bits

Software de servidor

Terminal dedicado ao inventário de software instalado nos servidores.

Campos de consulta disponíveis:

sw_id; computer_name; department_name; software_name; normalized_software_name; is_licensable; software_version; software_manufacturer; homologation_status; instalation_date; machine_type; machine_id; family; label; category_name; category_description; group_name; group_description

SNMP

Ponto final para consultar dispositivos de rede monitorados via SNMP, como switches e roteadores.

Campos de consulta disponíveis:

name; object_id; ip_address; department_name; contact; location; monitored_by; machine_id; dns_name; up_time; agent_id; description; interfaces

Campos de interface disponíveis:

interface_name; index; ip_address; type; mtu; speed; admin_status; operational_status; mac_address

Formulário personalizado – Estações de trabalho

Ponto final dinâmico baseado em formulários personalizados criados pelo usuário para estações de trabalho.

Características:
  • Os campos retornados pela API correspondem exatamente aos campos definidos pelo usuário na plataforma.
  • Estrutura flexível sem esquema fixo.

Formulário personalizado – Servidores

Ponto final dinâmico baseado em formulários personalizados criados pelo usuário para servidores.

Características:
  • Os campos expostos pela API refletem totalmente os campos configurados pelo usuário.
  • Permite o enriquecimento do inventário padrão do servidor.

Desempenho do desktop – Detalhes gerais

Terminal que fornece indicadores de desempenho gerais consolidados para estações de trabalho.

Campos de consulta disponíveis:
machine_id; computer_name; login_name; department_name; avg_cpu; avg_mem; perc_disk

Desempenho do desktop – Processo da CPU

O endpoint concentrou-se no consumo de CPU por processo nas estações de trabalho.

Campos de consulta disponíveis:
machineId; loginName; computerName; process; value

Desempenho do desktop – Processo de memória

O endpoint focava no consumo de memória por processo nas estações de trabalho.

Campos de consulta disponíveis:
machineId; loginName; computerName; process; value

Collective IQ – SWAGGER

As APIs públicas do Collective IQ ®ITAM estão documentadas usando Swagger:
LAD1: almaden
LAD2: almaden

APIs públicas SmartCenter APIs públicas CIQ ITAM

Compartilhe este documento

APIs públicas CIQ ITAM

Ou copie o link

Índice
Role até o topo