Documentation
Table of Contents
Objeto de escenario web
Los siguientes objetos est¨¢n directamente relacionados con la API webcheck.
Escenario web
El objeto de escenario web tiene las siguientes propiedades.
| Propiedad | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| httptestid | ID | ID del escenario web. Comportamiento de la propiedad: - solo lectura - obligatorio para operaciones de actualizaci¨®n |
| hostid | ID | ID del host al que pertenece el escenario web. Comportamiento de la propiedad: - constante - obligatorio para operaciones de creaci¨®n |
| nombre | cadena | Nombre del escenario web. Comportamiento de la propiedad: - obligatorio para las operaciones de creaci¨®n |
| agent | string | Cadena del agente de usuario que ser¨¢ utilizada por el escenario web. Predeterminado: Áú»¢¶Ä²© |
| ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô | entero | M¨¦todo de ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô que utilizar¨¢ el escenario web. Valores posibles: 0 - (predeterminado) ninguno; 1 - ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô HTTP b¨¢sica; 2 - ´¡³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô NTLM. |
| retraso | cadena | Intervalo de ejecuci¨®n del escenario web. Acepta segundos o unidades de tiempo con sufijo (por ejemplo, 30 s, 1 m, 2 h, 1 d) o una macro de usuario. Valor predeterminado: 1m. |
| headers | array | encabezados HTTP que se enviar¨¢n al realizar una solicitud. |
| http_password | cadena | Contrase?a utilizada para la ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô b¨¢sica HTTP o NTLM. |
| http_proxy | cadena | Proxy que ser¨¢ utilizado por el escenario web dado como http://[nombre de usuario[:contrase?a]@]proxy.example.com[:puerto]. |
| http_user | cadena | Nombre de usuario utilizado para la ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô b¨¢sica HTTP o NTLM. |
| retries | entero | N¨²mero de veces que un escenario web intentar¨¢ ejecutar cada paso antes de fallar. Valor predeterminado: 1. |
| ssl_cert_file | cadena | Nombre del archivo de certificado SSL utilizado para la ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô del cliente (debe estar en formato PEM). |
| ssl_key_file | cadena | Nombre del archivo de clave privada SSL utilizado para la ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô del cliente (debe estar en formato PEM). |
| ssl_key_password | cadena | Contrase?a de clave privada SSL. |
| status | integer | Si el escenario web est¨¢ habilitado. Valores posibles: 0 - (predeterminado) habilitado; 1 - deshabilitado. |
| templateid | ID | ID del escenario web de la plantilla principal. Comportamiento de la propiedad: - solo lectura |
| variables | matriz | Escenario web variables. |
| verify_host | integer | Si se valida que el nombre de host para la conexi¨®n coincide con el del certificado del host. Valores posibles: 0 - (predeterminado) omitir la verificaci¨®n del host;<br >1 - verificar host. |
| verify_peer | integer | Si se valida que el certificado del host es aut¨¦ntico. Valores posibles: 0 - (predeterminado) omitir verificaci¨®n de pares; 1 - verificar pares. |
| uuid | cadena | Identificador ¨²nico global, utilizado para vincular escenarios web importados con los ya existentes. Generado autom¨¢ticamente, si no se proporciona. Comportamiento de la propiedad: - compatible si el escenario web pertenece a una plantilla |
Etiqueta de escenario web
El objeto de etiqueta del escenario web tiene las siguientes propiedades.
| Propiedad | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| tag | cadena | Nombre de etiqueta del escenario web. Comportamiento de la propiedad: - obligatorio |
| value | cadena | Valor de etiqueta de escenario web. |
Paso del escenario
El objeto de paso del escenario define una verificaci¨®n de escenario web espec¨ªfica. Tiene las siguientes propiedades.
| Propiedad | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| name | cadena | Nombre del paso del escenario. Comportamiento de la propiedad: - requerido |
| no | entero | N¨²mero de secuencia del paso en un escenario web. Comportamiento de la propiedad: - requerido |
| url | cadena | URL a verificar. Comportamiento de la propiedad: - obligatorio |
| follow_redirects | entero | Si se deben seguir los redireccionamientos HTTP. Valores posibles: 0: no seguir los redireccionamientos; 1: (predeterminado) seguir los redireccionamientos. |
| headers | matriz | encabezados HTTP que se enviar¨¢n al realizar una solicitud. Los encabezados de los pasos del escenario sobrescribir¨¢n los encabezados especificados para el escenario web. |
| posts | cadena/matriz | Variables HTTP POST como una cadena (datos de publicaci¨®n sin procesar) o como una matriz de campos HTTP (datos del campo de formulario). |
| required | cadena | Texto que debe estar presente en la respuesta. |
| retrieve_mode | entero | Parte de la respuesta HTTP que el paso del escenario debe recuperar. Valores posibles: 0 - (predeterminado) solo cuerpo; 1 - solo encabezados;< br>2 - encabezados y cuerpo. |
| status_codes | cadena | Rangos de c¨®digos de estado HTTP requeridos, separados por comas. |
| timeout | string | Tiempo de espera de solicitud en segundos. Acepta segundos, unidad de tiempo con sufijo o una macro de usuario. Predeterminado: 15 s. M¨¢ximo: 1h. M¨ªnimo: 1s. |
| variables | matriz | Paso del escenario variables. |
| query_fields | matriz | Campos de consulta: conjunto de campos HTTP que se agregar¨¢n a la URL al realizar una solicitud. |
Campo HTTP
El objeto de campo HTTP define el nombre y el valor que se utiliza para especificar las variables del escenario web, los encabezados HTTP y los campos POST o de consulta. Tiene las siguientes propiedades.
| Propiedad | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| name | cadena | Nombre del encabezado/variable/POST o campo GET. Comportamiento de la propiedad: - obligatorio |
| value | cadena | Valor del encabezado/variable/campo POST o GET. Comportamiento de la propiedad: - obligatorio |