Objeto media type

Os seguintes objetos estão diretamente relacionados à API mediatype.

Tipo de mídia

O objeto de tipo de mídia tem as seguintes propriedades.

Property Type Description
mediatypeid ID ID do tipo de mídia.

Comportamento da propriedade:
- somente leitura
- obrigatório para operações de atualização
name string Nome do tipo de mídia.

Comportamento da propriedade:
- obrigatório para operações de criação
type integer Transporte usado pelo tipo de mídia.

Valores possíveis:
0 - Email;
1 - Script;
2 - SMS;
4 - Webhook.

Comportamento da propriedade:
- obrigatório para operações de criação
exec_path string Nome do arquivo de script (por exemplo, notification.sh) localizado no diretório especificado no parâmetro de configuração do server AlertScriptsPath.

Comportamento da propriedade:
- obrigatório se type estiver definido como "Script"
gsm_modem string Nome do dispositivo serial do modem GSM.

Comportamento da propriedade:
- obrigatório se type estiver definido como "SMS"
passwd string Senha de autenticação.

Comportamento da propriedade:
- suportado se smtp_authentication estiver definido como "Normal password"
provider integer Provedor de email.

Valores possíveis:
0 - (padrão) Generic SMTP;
1 - Gmail;
2 - Gmail relay;
3 - Office365;
4 - Office365 relay.
smtp_email string Endereço de email de onde as notificações serão enviadas.

Comportamento da propriedade:
- obrigatório se type estiver definido como "Email"
smtp_helo string SMTP HELO.

Comportamento da propriedade:
- suportado se type estiver definido como "Email"
smtp_server string server SMTP.

Comportamento da propriedade:
- obrigatório se type estiver definido como "Email"
smtp_port integer Porta do server SMTP para conexão.

Padrão: 25.

Comportamento da propriedade:
- suportado se type estiver definido como "Email"
smtp_security integer Nível de segurança da conexão SMTP a ser usado.

Valores possíveis:
0 - (padrão) Nenhum;
1 - STARTTLS;
2 - SSL/TLS.

Comportamento da propriedade:
- suportado se type estiver definido como "Email"
smtp_verify_host integer Verificação SSL do host para SMTP.

Valores possíveis:
0 - (padrão) Não;
1 - Sim.

Comportamento da propriedade:
- suportado se smtp_security estiver definido como "STARTTLS" ou "SSL/TLS"
smtp_verify_peer integer Verificação SSL do peer para SMTP.

Valores possíveis:
0 - (padrão) Não;
1 - Sim.

Comportamento da propriedade:
- suportado se smtp_security estiver definido como "STARTTLS" ou "SSL/TLS"
smtp_authentication integer Método de autenticação SMTP a ser usado.

Valores possíveis:
0 - (padrão) Nenhum;
1 - Normal password;
2 - OAuth token.
A autenticação OAuth não é permitida para o provedor de email Office365 relay.

Comportamento da propriedade:
- suportado se type estiver definido como "Email"
redirection_url string URL do frontend do Zabbix para redirecionar de volta a autorização OAuth.

Padrão:
Valor da propriedade url das configurações da API com a parte zabbix.php?action=oauth.authorize

Comportamento da propriedade:
- obrigatório se smtp_authentication estiver definido como "OAuth token"
client_id string O identificador do cliente registrado no servidor de autorização OAuth.

Comportamento da propriedade:
- obrigatório se smtp_authentication estiver definido como "OAuth token"
client_secret string O segredo do cliente registrado no servidor de autorização OAuth. Acessível apenas para usuário do tipo Super Admin.

Comportamento da propriedade:
- obrigatório se smtp_authentication estiver definido como "OAuth token"
authorization_url string URL OAuth, com parâmetros, para obter tokens de acesso e atualização.

Comportamento da propriedade:
- obrigatório se smtp_authentication estiver definido como "OAuth token"
token_url string URL OAuth para trocar o token de autorização por tokens de acesso e atualização.
Essa URL também é usada pelo server para atualizar um token de acesso inválido.

Comportamento da propriedade:
- obrigatório se smtp_authentication estiver definido como "OAuth token"
tokens_status integer Máscara de bits do status dos tokens.

Valores possíveis:
0 - (padrão) Ambos os tokens contêm valor inválido
1 - O token de acesso contém valor válido
2 - O token de atualização contém valor válido
3 - Ambos os tokens contêm valor válido.

Comportamento da propriedade:
- suportado se smtp_authentication estiver definido como "OAuth token"
access_token string Valor do token de acesso OAuth.

Comportamento da propriedade:
- obrigatório se smtp_authentication estiver definido como "OAuth token"
access_token_updated timestamp Timestamp da última modificação de access_token feita pelo server ao atualizar com refresh_token ou pela API em alterações de token.

Comportamento da propriedade:
- suportado se smtp_authentication estiver definido como "OAuth token"
access_expires_in integer Tempo, em segundos, até que access_token fique desatualizado e seja necessário fazer uma solicitação para refresh_url.
É definido pelo server do Zabbix na atualização de access_token ou pela API em alterações de token.

O timestamp é calculado somando o valor de access_token_updated.

Comportamento da propriedade:
- suportado se smtp_authentication estiver definido como "OAuth token"
refresh_token string Valor do token de atualização OAuth.

Comportamento da propriedade:
- obrigatório se smtp_authentication estiver definido como "OAuth token"
status integer Se o tipo de mídia está habilitado.

Valores possíveis:
0 - (padrão) Habilitado;
1 - Desabilitado.
username string Nome de usuário.

Comportamento da propriedade:
- suportado se smtp_authentication estiver definido como "Normal password"
maxsessions integer Número máximo de alertas que podem ser processados em paralelo.

Valores possíveis se type estiver definido como "SMS": 1.

Valores possíveis se type estiver definido como "Email", "Script" ou "Webhook": 0-100.

Padrão: 1.
maxattempts integer Número máximo de tentativas para enviar um alerta.

Valores possíveis: 1-100.

Padrão: 3.
attempt_interval string Intervalo entre tentativas de nova execução.
Aceita segundos e unidade de tempo com sufixo.

Valores possíveis: 0-1h.

Padrão: 10s.
message_format integer Formato da mensagem.

Valores possíveis:
0 - Texto simples;
1 - (padrão) HTML.

Comportamento da propriedade:
- suportado se type estiver definido como "Email"
script text Corpo do script do webhook (JavaScript).

Comportamento da propriedade:
- obrigatório se type estiver definido como "Webhook"
timeout string Tempo limite do script do webhook.
Aceita segundos e unidade de tempo com sufixo.

Valores possíveis: 1-60s.

Padrão: 30s.

Comportamento da propriedade:
- suportado se type estiver definido como "Webhook"
process_tags integer Processa valores de propriedades JSON na resposta do script do webhook como tags. Essas tags são adicionadas a quaisquer tags de problema já existentes.

Valores possíveis:
0 - (padrão) Ignorar a resposta do script do webhook;
1 - Processar a resposta do script do webhook como tags.

Comportamento da propriedade:
- suportado se type estiver definido como "Webhook"
show_event_menu integer Inclui uma entrada no menu de eventos que aponta para uma URL personalizada. Também adiciona a propriedade urls à saída de problem.get e event.get.

Valores possíveis:
0 - (padrão) Não incluir a entrada do menu de eventos nem a propriedade urls;
1 - Incluir a entrada do menu de eventos e a propriedade urls.

Comportamento da propriedade:
- suportado se type estiver definido como "Webhook"
event_menu_url string URL usada na entrada do menu de eventos e na propriedade urls retornada por problem.get e event.get.

Comportamento da propriedade:
- suportado se show_event_menu estiver definido como "Include event menu entry and urls property"
event_menu_name string Nome usado para a entrada do menu de eventos e na propriedade urls retornada por problem.get e event.get.

Comportamento da propriedade:
- suportado se show_event_menu estiver definido como "Include event menu entry and urls property"
parameters array Parâmetros de Webhook ou script.

Comportamento da propriedade:
- suportado se type estiver definido como "Webhook" ou "Script"
description text Descrição do tipo de mídia.

Parâmetros do webhook

Os parâmetros do webhook possuem as seguintes propriedades.

Propriedade Tipo Descrição
name string Nome do parâmetro.

Comportamento da propriedade:
- obrigatório
value string Valor do parâmetro, suporta macros.
As macros suportadas estão descritas na página Macros suportadas.

Parâmetros do script

Os parâmetros do script possuem as seguintes propriedades.

Propriedade Tipo Descrição
sortorder integer A ordem em que os valores dos parâmetros serão passados para o script como argumentos de linha de comando, começando com 0 como o primeiro.

Comportamento da propriedade:
- obrigatório
value string Valor do parâmetro, suporta macros.
As macros suportadas estão descritas na página Macros suportadas.

Modelo de mensagem

O objeto de modelo de mensagem define um modelo que será usado como mensagem padrão para operações de ação para enviar uma notificação. Ele possui as seguintes propriedades.

Propriedade Tipo Descrição
eventsource integer Fonte do evento.

Valores possíveis:
0 - Triggers;
1 - Descoberta;
2 - Autoregistro;
3 - Interno;
4 - Serviços.

Comportamento da propriedade:
- obrigatório
recovery integer Modo de operação.

Valores possíveis:
0 - Operações;
1 - Operações de recuperação;
2 - Operações de atualização.

Comportamento da propriedade:
- obrigatório
subject string Assunto da mensagem.
message string Texto da mensagem.