[comment]: # aside: 1

[comment]: # ({b751c407-a17bb95b})
# Objeto de escenario web

Los siguientes objetos están directamente relacionados con la API `webcheck`.

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

[comment]: # ({24442f22-e60908bb})
### Escenario web

El objeto escenario web tiene las siguientes propiedades.

|Propiedad|[Tipo](/manual/api/reference_commentary#data-types)|Descripción|
|--|--|------|
|httptestid|ID|ID del escenario web.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *solo lectura*<br>- *requerido* para operaciones de actualización|
|hostid|ID|ID del host al que pertenece el escenario web.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *constante*<br>- *requerido* para operaciones de creación|
|name|string|Nombre del escenario web.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *requerido* para operaciones de creación|
|agent|string|Cadena de agente de usuario que será utilizada por el escenario web.<br><br>Por defecto: Zabbix|
|authentication|integer|Método de autenticación que será utilizado por el escenario web.<br><br>Valores posibles:<br>0 - *(por defecto)* ninguno;<br>1 - autenticación HTTP básica;<br>2 - autenticación NTLM;<br>3 - autenticación Kerberos;<br>4 - autenticación Digest.|
|delay|string|Intervalo de ejecución del escenario web.<br><br>Acepta segundos o unidad de tiempo con sufijo (por ejemplo, 30s, 1m, 2h, 1d), o una macro de usuario.<br><br>Por defecto: 1m.|
|headers|array|[Cabeceras HTTP](/manual/api/reference/httptest/object#http-field) que se enviarán al realizar una petición.|
|http\_password|string|Contraseña utilizada para autenticación HTTP básica, NTLM, Kerberos o Digest.|
|http\_proxy|string|Proxy que será utilizado por el escenario web dado como *http://\[usuario\[:contraseña\]@\]proxy.ejemplo.com\[:puerto\]*.|
|http\_user|string|Nombre de usuario utilizado para autenticación HTTP básica, NTLM, Kerberos o Digest.|
|retries|integer|Número de veces que un escenario web intentará ejecutar cada paso antes de fallar.<br><br>Por defecto: 1.|
|ssl\_cert\_file|string|Nombre del archivo de certificado SSL utilizado para la autenticación del cliente (debe estar en formato PEM).|
|ssl\_key\_file|string|Nombre del archivo de clave privada SSL utilizado para la autenticación del cliente (debe estar en formato PEM).|
|ssl\_key\_password|string|Contraseña de la clave privada SSL.|
|status|integer|Indica si el escenario web está habilitado.<br><br>Valores posibles:<br>0 - *(por defecto)* habilitado;<br>1 - deshabilitado.|
|templateid|ID|ID del escenario web de la template padre.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *solo lectura*|
|variables|array|[Variables](/manual/api/reference/httptest/object#http-field) del escenario web.|
|verify\_host|integer|Indica si se debe validar que el nombre del host para la conexión coincida con el del certificado del host.<br><br>Valores posibles:<br>0 - *(por defecto)* omitir la verificación del host;<br>1 - verificar el host.|
|verify\_peer|integer|Indica si se debe validar que el certificado del host es auténtico.<br><br>Valores posibles:<br>0 - *(por defecto)* omitir la verificación del par;<br>1 - verificar el par.|
|uuid|string|Identificador global único, utilizado para vincular escenarios web importados con los ya existentes. Se genera automáticamente si no se proporciona.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *soportado* si el escenario web pertenece a una template|

[comment]: # ({/24442f22-e60908bb})

[comment]: # ({dcde4da9-eb20f47d})
### Paso del escenario

El objeto paso del escenario define una comprobación específica de escenario web. Tiene
las siguientes propiedades.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|name|string|Nombre del paso del escenario.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|no|integer|Número de secuencia del paso en un escenario web.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|url|string|URL que se va a comprobar.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|follow\_redirects|integer|Indica si se deben seguir las redirecciones HTTP.<br><br>Valores posibles:<br>0 - no seguir redirecciones;<br>1 - *(default)* seguir redirecciones.|
|headers|array|[Encabezados HTTP](/manual/api/reference/httptest/object#http-field) que se enviarán al realizar una solicitud. Los encabezados del paso del escenario sobrescribirán los encabezados especificados para el escenario web.|
|posts|string/array|Variables HTTP POST como una cadena (datos POST sin procesar) o como un array de [campos HTTP](/manual/api/reference/httptest/object#http-field) (datos de campos de formulario).|
|required|string|Texto que debe estar presente en la respuesta.|
|retrieve\_mode|integer|Parte de la respuesta HTTP que el paso del escenario debe recuperar.<br><br>Valores posibles:<br>0 - *(default)* solo el cuerpo;<br>1 - solo los encabezados;<br>2 - encabezados y cuerpo.|
|status\_codes|string|Rangos de códigos de estado HTTP requeridos, separados por comas.|
|timeout|string|Tiempo de espera de la solicitud en segundos. Acepta segundos, unidad de tiempo con sufijo o una macro de usuario.<br><br>Predeterminado: 15s. Máximo: 1h. Mínimo: 1s.|
|variables|array|[Variables](/manual/api/reference/httptest/object#http-field) del paso del escenario.|
|query\_fields|array|Campos de consulta: array de [campos HTTP](/manual/api/reference/httptest/object#http-field) que se añadirán a la URL al realizar una solicitud.|

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

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

El objeto de campo HTTP define el nombre y el valor que se utilizan para especificar las variables del escenario web, las cabeceras HTTP y los campos POST o los campos de consulta.
Tiene las siguientes propiedades.

|Propiedad|[Tipo](/manual/api/reference_commentary#data-types)|Descripción|
|--|--|------|
|name|string|Nombre de la cabecera/variable/campo POST o GET.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *obligatorio*|
|value|string|Valor de la cabecera/variable/campo POST o GET.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *obligatorio*|

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

[comment]: # ({ec1bbb32-c7ab7fb0})
### Etiqueta de escenario web

El objeto de etiqueta de escenario web tiene las siguientes propiedades.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|tag|string|Nombre de la etiqueta del escenario web.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|value|string|Valor de la etiqueta del escenario web.|

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