Este documento fornece uma introdução à API do Zabbix, explicando o que é uma API, como a API do Zabbix pode ser usada para automatizar tarefas, criar dashboards e relatórios, e descrevendo os principais conceitos como estrutura JSON, métodos, parâmetros e retornos.

1. Robert Silva
Especialista em monitoramento
Desenvolvedor Python
JLCP
robert.silva@jlcp.com.br

2. Primeiros passos com a API do Zabbix

3. Agenda
• O que é API?
• Para que server a API do Zabbix?
• Visão geral da API do Zabbix
• O que é JSON?
• Estrutura da API
• Fluxo de mensagem
• Qual chamada utilizar?
• Quais parâmetros devo enviar?
• O que significa o retorno?
• Bibliotecas.

4. O que é API?
● Application Programming Interface;
● Em português: Interface de Programação de Aplicações;
● É uma forma de integrar sistemas, possibilitando benefícios como:
● Segurança de dados;
● Facilidade na troca de informações com diferentes linguagens de
programação.

5. Para que serve a API do Zabbix?
● Criar, Ler, Atualizar e Deletar objetos do Zabbix;
● Exemplos:
● Criar: Hosts, itens, triggers e etc;
● Ler: Hosts, itens, triggers, history, events e etc;
● Atualizar: Hosts, itens, triggers e etc;
● Deletar: Hosts, itens, triggers e etc.

6. Para que serve a API do Zabbix?
● E o que fazer com essas ações?
● Automatizar tarefas;
● Criar dashboards;
● Criar relatórios;
● Etc.

7. Visão geral da API do Zabbix
• API baseada no Frontend do Zabbix;
• http://<IP-DNS-Frontend>/zabbix/api_jsonrpc.php;
• Utiliza o protocolo JSON RPC 2.0;
• Utiliza a mesma regra de permissão do Zabbix.

8. O que é JSON?
• JSON (JavaScript Object Notation);
• JSON é um formato leve para troca de informações entre sistemas;
• Possui duas estruturas:
• Uma coleção de chave/valor;
• Uma lista ordenada, conhecida como array em algumas
linguagens de programação;
• https://jsonlint.com/
• https://www.jsonrpc.org/specification
• http://json.org/

9. O que é JSON?
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"groups": [
{
"groupid": "2",
"name": "Linux servers",
"internal": "0",
"flags": "0"
},
{
"groupid": "4",
"name": "Zabbix servers",
"internal": "0",
"flags": "0"
}
]
}
],
"id": 2
}

10. Estrutura da API
• A API é estruturada em Classes;
• Host, Hostgroup, Item, Trigger e etc;
• Possui atualmente mais de 232 métodos;
• Os principais métodos são:
• Get – Lista informações;
• Create – Cria objeto;
• Update – Atualiza objeto;
• Delete – Deleta objeto;
• Classes de dados históricos possuem somente o método Get;
• Exemplo: Event, History e Problem.

11. Fluxo de mensagem da API
Cliente API Zabbix API
Token
user.login (Autenticação)
hostgroup.get (Lista de grupo de hosts)
Result
host.get (Lista de hosts)
Result
user.logout (Logoff)

12. Qual
chamada
utilizar?
Fonte: https://www.zabbix.com/documentation/4.0/manual/api/reference

13. Quais
parâmetros
devo enviar?
Fonte: https://www.zabbix.com/documentation/4.0/manual/api/reference/host/get

14. Tipos de parâmetros
Tipo Descrição Exemplo
String Uma string em python "hostids": "1034"
Array Uma lista em python "hostids": ["1034", "1035", "1036"]
Flag Qualquer valor, seja string ou número flag = 1
Query É uma consulta com os objetos do
método utilizado
"extend"
["name", "status"]
Object Um dicionário em python, elemento
com chave: valor
{"status": 1}

15. O que significa o retorno ?{
"jsonrpc": "2.0",
"result": [
{
"itemid": "23298",
"type": "0",
"snmp_community": "",
"snmp_oid": "",
"hostid": "10084",
"name": "Context switches per second",
"key_": "system.cpu.switches",
"delay": "1m",
"history": "7d",
"trends": "365d",
"lastvalue": "2552",
"lastclock": "1351090998",
"prevvalue": "2641",
"state": "0",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "sps",

16. Bibliotecas
Fonte: https://zabbix.org/wiki/Docs/api/libraries

17. Casos de uso na JLCP
● Dashboards;
● Automaçãoes;
● Novas funcionalidades para o Zabbix;
● Relatórios em PDF;
● Entre outros.

18. Benefícios da API para JLCP
● Redução de custo operacional;
● Agilidade na entrega de projetos;
● Fidelização de clientes.

19. Obrigado pela
presença!
Primeiros passos com a API Zabbix
(Gratuito)
https://ead.jlcp.com.br