[comment]: # aside: 1

[comment]: # ({43284bfe-8b1700c1})
# Objeto script

Os seguintes objetos estão diretamente relacionados à API `script`.

[comment]: # ({/43284bfe-8b1700c1})

[comment]: # ({1c7e0362-9c6db006})
### Script

O objeto script possui as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|scriptid|ID|ID do script.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*<br>- *obrigatório* para operações de atualização|
|name|string|Nome do script.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* para operações de criação|
|type|integer|Tipo de script.<br><br>Valores possíveis se `scope` estiver definido como "operação de ação":<br>0 - Script;<br>1 - IPMI;<br>2 - SSH;<br>3 - TELNET;<br>5 - Webhook.<br><br>Valores possíveis se `scope` estiver definido como "ação manual de host" ou "ação manual de evento":<br>6 - URL.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* para operações de criação|
|command|string|Comando a ser executado.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `type` estiver definido como "Script", "IPMI", "SSH", "TELNET" ou "Webhook"|
|scope|integer|Escopo do script.<br><br>Valores possíveis:<br>1 - operação de ação;<br>2 - ação manual de host;<br>4 - ação manual de evento.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* para operações de criação|
|execute\_on|integer|Onde executar o script.<br><br>Valores possíveis:<br>0 - executar no Zabbix agent;<br>1 - executar no Zabbix server. É *suportado* apenas se a execução de scripts globais estiver habilitada no Zabbix server;<br>2 - *(padrão)* executar no Zabbix server ou proxy.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `type` estiver definido como "Script"|
|menu\_path|string|Pastas separadas por barra que formam uma navegação tipo menu no frontend ao clicar no host ou evento.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `scope` estiver definido como "ação manual de host" ou "ação manual de evento"|
|authtype|integer|Método de autenticação usado para o tipo de script SSH.<br><br>Valores possíveis:<br>0 - senha;<br>1 - chave pública.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `type` estiver definido como "SSH"|
|username|string|Nome de usuário usado para autenticação.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `type` estiver definido como "SSH" ou "TELNET"|
|password|string|Senha usada para scripts SSH com autenticação por senha e scripts TELNET.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `type` estiver definido como "SSH" e `authtype` estiver definido como "senha", ou `type` estiver definido como "TELNET"|
|publickey|string|Nome do arquivo de chave pública usado para scripts SSH com autenticação por chave pública.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `type` estiver definido como "SSH" e `authtype` estiver definido como "chave pública"|
|privatekey|string|Nome do arquivo de chave privada usado para scripts SSH com autenticação por chave pública.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `type` estiver definido como "SSH" e `authtype` estiver definido como "chave pública"|
|port|string|Número da porta usada para scripts SSH e TELNET.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `type` estiver definido como "SSH" ou "TELNET"|
|groupid|ID|ID do grupo de hosts no qual o script pode ser executado.<br><br>Se definido como "0", o script estará disponível em todos os grupos de hosts.<br><br>Padrão: 0.|
|usrgrpid|ID|ID do grupo de usuários que poderá executar o script.<br><br>Se definido como "0", o script estará disponível para todos os grupos de usuários.<br><br>Padrão: 0.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `scope` estiver definido como "ação manual de host" ou "ação manual de evento"|
|host\_access|integer|Permissões de host necessárias para executar o script.<br><br>Valores possíveis:<br>2 - *(padrão)* leitura;<br>3 - gravação.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `scope` estiver definido como "ação manual de host" ou "ação manual de evento"|
|confirmation|string|Texto do pop-up de confirmação.<br>O pop-up aparecerá ao tentar executar o script a partir do frontend do Zabbix.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `scope` estiver definido como "ação manual de host" ou "ação manual de evento"|
|timeout|string|Tempo limite de execução do script webhook em segundos. Sufixos de tempo são suportados (por exemplo, 30s, 1m).<br><br>Valores possíveis: 1-60s.<br><br>Padrão: 30s.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `type` estiver definido como "Webhook"|
|parameters|array|Array de [parâmetros de entrada do webhook](/manual/api/reference/script/object#webhook-parameters).<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `type` estiver definido como "Webhook"|
|description|string|Descrição do script.|
|url|string|URL definida pelo usuário.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `type` estiver definido como "URL"|
|new_window|integer|Abrir URL em uma nova janela.<br><br>Valores possíveis:<br>0 - Não;<br>1 - *(padrão)* Sim.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `type` estiver definido como "URL"|
|manualinput|integer|Indica se o script aceita entrada fornecida pelo usuário.<br><br>Valores possíveis:<br>0 - *(padrão)* Desabilitado;<br>1 - Habilitado;<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `scope` estiver definido como "ação manual de host" ou "ação manual de evento"|
|manualinput_prompt|string|Texto do prompt de entrada manual.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `manualinput` estiver definido como "Habilitado"|
|manualinput_validator|string|Um campo de string de caracteres usado para validar a entrada fornecida pelo usuário. A string consiste em uma expressão regular ou um conjunto de valores separados por vírgulas.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `manualinput` estiver definido como "Habilitado"|
|manualinput_validator_type|integer|Determina o tipo de entrada do usuário esperada.<br><br>Valores possíveis:<br>0 - *(padrão)* String. Indica que manualinput_validator deve ser tratado como uma expressão regular;<br>1 - Lista. Indica que manualinput_validator deve ser tratado como uma lista separada por vírgulas de possíveis valores de entrada.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `manualinput` estiver definido como "Habilitado"|
|manualinput_default_value|string|Valor padrão para preenchimento automático da entrada do usuário.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *suportado* se `manualinput_validator_type` estiver definido como "String"|

[comment]: # ({/1c7e0362-9c6db006})

[comment]: # ({4ab66f57-05b0e37d})
#### Parâmetros do webhook

Os parâmetros passados para o script do webhook quando ele é chamado têm as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|name|string|Nome do parâmetro.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório*|
|value|string|Valor do parâmetro. Suporta [macros](/manual/appendix/macros/supported_by_location).|

[comment]: # ({/4ab66f57-05b0e37d})

[comment]: # ({0ba46586-587d2fd0})
### Depuração

Informações de depuração do script webhook executado. O objeto de depuração possui as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|logs|array|Array de [entradas de log](/manual/api/reference/script/object#log-entry).|
|ms|string|Duração da execução do script em milissegundos.|

[comment]: # ({/0ba46586-587d2fd0})

[comment]: # ({f7a09e87-8ea23127})
#### Entrada de log

O objeto de entrada de log possui as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|level|integer|Nível de log.|
|ms|string|O tempo decorrido em milissegundos desde que o script foi executado antes da entrada de log ser adicionada.|
|message|string|Mensagem de log.|

[comment]: # ({/f7a09e87-8ea23127})