[comment]: # translation:outdated

[comment]: # ({a17bb95b-a17bb95b})
# > Objeto de cenário Web

Os objetos a seguir estão diretamente relacionados à API `webcheck`.

[comment]: # ({/a17bb95b-a17bb95b})

[comment]: # ({9581e437-e60908bb})
### Cenário Web

O objeto de cenário da web tem as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|httptestid|string|*(somente leitura)* ID do cenário web.|
|**hostid**<br>(requirido)|string|ID do host ao qual o cenário da web pertence.|
|**name**<br>(requirido)|string|Nome do cenário web.|
|agent|string|String do agente do usuário que será usada pelo cenário web.<br><br>Padrão: Zabbix|
|authentication|integer|Método de autenticação que será usado pelo cenário web.<br><br>Valores possíveis:<br>0 - *(padrão)* none;<br>1 - autenticação HTTP básica;<br>2 - Autenticação NTLM.|
|delay|string|Intervalo de execução do cenário web. Aceita segundos, unidade de tempo com sufixo e macro do usuário..<br><br>Padrão: 1m.|
|headers|array de [HTTP fields](/manual/api/reference/httptest/object#HTTP field)|cabeçalhos HTTP que serão enviados ao realizar uma solicitação.|
|http\_password|string|Senha usada para autenticação básica HTTP ou NTLM.|
|http\_proxy|string|Proxy que será usado pelo cenário da web dado como *http://\[username\[:password\]@\]proxy.example.com\[:port\]*.|
|http\_user|string|Nome de usuário usado para autenticação HTTP ou NTLM básica.|
|nextcheck|timestamp|*(somente leitura)* Hora da próxima execução do cenário web.|
|retries|integer|Número de vezes que um cenário da Web tentará executar cada etapa antes de falhar.<br><br>Padrão: 1.|
|ssl\_cert\_file|string|Nome do arquivo de certificado SSL usado para autenticação do cliente (deve estar no formato PEM).|
|ssl\_key\_file|string|Nome do arquivo de chave privada SSL usado para autenticação do cliente (deve estar no formato PEM).|
|ssl\_key\_password|string|Senha da chave privada SSL.|
|status|integer|Se o cenário da Web está ativado.<br><br>Os valores possíveis são:<br>0 - *(padrão)* Ativado;<br>1 - Desativado.|
|templateid|string|*(somente leitura)* ID do cenário Web do modelo pai.|
|variables|array of [HTTP fields](/manual/api/reference/httptest/object#HTTP field)|Variáveis ​​de cenário web.|
|verify\_host|integer|Se deve verificar se o nome do host especificado no certificado SSL corresponde ao usado no cenário.<br><br>Os valores possíveis são:<br>0 - *(padrão)* pular a verificação do host;<br>1 - verificar host.|
|verify\_peer|integer|Se deve verificar o certificado SSL do servidor web.<br><br>Os valores possíveis são:<br>0 - *(padrão)* pular verificação de pares;<br>1 - verificar par.|
|uuid|string|*(somente leitura em cenários da web já existentes)*<br>Identificador exclusivo global, usado para vincular cenários Web importados a cenários já existentes. Usado apenas para cenários Web em modelos.|

[comment]: # ({/9581e437-e60908bb})

[comment]: # ({77f50b6b-c7ab7fb0})
### Cenário Web

O objeto de cenário da web tem as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|httptestid|string|*(somente leitura)* ID do cenário web.|
|**hostid**<br>(requirido)|string|ID do host ao qual o cenário da web pertence.|
|**name**<br>(requirido)|string|Nome do cenário web.|
|agent|string|String do agente do usuário que será usada pelo cenário web.<br><br>Padrão: Zabbix|
|authentication|integer|Método de autenticação que será usado pelo cenário web.<br><br>Valores possíveis:<br>0 - *(padrão)* none;<br>1 - autenticação HTTP básica;<br>2 - Autenticação NTLM.|
|delay|string|Intervalo de execução do cenário web. Aceita segundos, unidade de tempo com sufixo e macro do usuário..<br><br>Padrão: 1m.|
|headers|array de [HTTP fields](/manual/api/reference/httptest/object#HTTP field)|cabeçalhos HTTP que serão enviados ao realizar uma solicitação.|
|http\_password|string|Senha usada para autenticação básica HTTP ou NTLM.|
|http\_proxy|string|Proxy que será usado pelo cenário da web dado como *http://\[username\[:password\]@\]proxy.example.com\[:port\]*.|
|http\_user|string|Nome de usuário usado para autenticação HTTP ou NTLM básica.|
|nextcheck|timestamp|*(somente leitura)* Hora da próxima execução do cenário web.|
|retries|integer|Número de vezes que um cenário da Web tentará executar cada etapa antes de falhar.<br><br>Padrão: 1.|
|ssl\_cert\_file|string|Nome do arquivo de certificado SSL usado para autenticação do cliente (deve estar no formato PEM).|
|ssl\_key\_file|string|Nome do arquivo de chave privada SSL usado para autenticação do cliente (deve estar no formato PEM).|
|ssl\_key\_password|string|Senha da chave privada SSL.|
|status|integer|Se o cenário da Web está ativado.<br><br>Os valores possíveis são:<br>0 - *(padrão)* Ativado;<br>1 - Desativado.|
|templateid|string|*(somente leitura)* ID do cenário Web do modelo pai.|
|variables|array of [HTTP fields](/manual/api/reference/httptest/object#HTTP field)|Variáveis ​​de cenário web.|
|verify\_host|integer|Se deve verificar se o nome do host especificado no certificado SSL corresponde ao usado no cenário.<br><br>Os valores possíveis são:<br>0 - *(padrão)* pular a verificação do host;<br>1 - verificar host.|
|verify\_peer|integer|Se deve verificar o certificado SSL do servidor web.<br><br>Os valores possíveis são:<br>0 - *(padrão)* pular verificação de pares;<br>1 - verificar par.|
|uuid|string|*(somente leitura em cenários da web já existentes)*<br>Identificador exclusivo global, usado para vincular cenários Web importados a cenários já existentes. Usado apenas para cenários Web em modelos.|

[comment]: # ({/77f50b6b-c7ab7fb0})

[comment]: # ({bec454ad-eb20f47d})
### Etapa do cenário

O objeto de etapa de cenário define uma verificação de cenário da web específica. 
Tem as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|httpstepid|string|*(somente leitura)* ID da etapa do cenário.|
|**name**<br>(requirido)|string|Nome da etapa do cenário.|
|**no**<br>(requirido)|integer|Número de sequência da etapa em um cenário web.|
|**url**<br>(requirido)|string|URL a ser verificado.|
|follow\_redirects|integer|Se deve seguir redirecionamentos HTTP.<br><br>Os valores possíveis são:<br>0 - não siga redirecionamentos;<br>1 - *(padrão)* seguir redirecionamentos.|
|headers|array de [HTTP fields](/manual/api/reference/httptest/object#HTTP field)|Cabeçalhos HTTP que serão enviados ao realizar uma solicitação. Os cabeçalhos das etapas do cenário substituirão os cabeçalhos especificados para o cenário web.|
|httptestid|string|*(somente leitura)* ID do cenário da web ao qual a etapa pertence.|
|posts|string<br>array de [HTTP fields](/manual/api/reference/httptest/object#HTTP field)|Variáveis ​​HTTP POST como uma string (dados brutos de postagem) ou como uma matriz de [HTTP fields](/manual/api/reference/httptest/object#HTTP field) (dados de campo de formulário).|
|required|string|Texto que deve estar presente na resposta.|
|retrieve\_mode|integer|Parte da resposta HTTP que a etapa do cenário deve recuperar.<br><br>Os valores possíveis são:<br>0 - *(padrão)* somente body;<br>1 - somente headers;<br>2 - headers e body.|
|status\_codes|string|Intervalos de códigos de status HTTP necessários separados por vírgulas.|
|timeout|string|Solicitar tempo limite em segundos. Aceita segundos, unidade de tempo com sufixo e macro do usuário.<br><br>Padrão: 15s. Máximo: 1h. Mínimo: 1s.|
|variables|array de [HTTP fields](/manual/api/reference/httptest/object#HTTP field)|Variáveis ​​da etapa do cenário.|
|query\_fields|array de [HTTP fields](/manual/api/reference/httptest/object#HTTP field)|Campos de consulta - array de [HTTP fields](/manual/api/reference/httptest/object#HTTP field) que será adicionado ao URL ao realizar uma solicitação|

[comment]: # ({/bec454ad-eb20f47d})

[comment]: # ({05773163-d69e8b7b})
### Campo HTTP

O objeto de campo HTTP define um nome e um valor que é usado para 
especificar a variável, o cabeçalho HTTP, os dados do campo de formulário 
POST dos dados do campo de consulta. Tem as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|**name**<br>(required)|string|Nome do cabeçalho / variável / Campo POST ou GET.|
|**value**<br>(required)|string|Valor do cabeçalho / variável / Campo POST ou GET.|

[comment]: # ({/05773163-d69e8b7b})