Documentation
Table of Contents
> Objeto de cen¨¢rio Web
Os objetos a seguir est?o diretamente relacionados ¨¤ API webcheck.
Cen¨¢rio Web
O objeto de cen¨¢rio da web tem as seguintes propriedades.
| Propriedade | Tipo | Descri??o |
|---|---|---|
| httptestid | string | (somente leitura) ID do cen¨¢rio web. |
| hostid (requirido) |
string | ID do host ao qual o cen¨¢rio da web pertence. |
| name (requirido) |
string | Nome do cen¨¢rio web. |
| agent | string | String do agente do usu¨¢rio que ser¨¢ usada pelo cen¨¢rio web. Padr?o: Áú»¢¶Ä²© |
| authentication | integer | M¨¦todo de autentica??o que ser¨¢ usado pelo cen¨¢rio web. Valores poss¨ªveis: 0 - (padr?o) none; 1 - autentica??o HTTP b¨¢sica; 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.. Padr?o: 1m. |
| headers | array de HTTP fields | 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. 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. Os valores poss¨ªveis s?o: 0 - (padr?o) Ativado; 1 - Desativado. |
| templateid | string | (somente leitura) ID do cen¨¢rio Web do modelo pai. |
| variables | array of HTTP fields | 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. Os valores poss¨ªveis s?o: 0 - (padr?o) pular a verifica??o do host; 1 - verificar host. |
| verify_peer | integer | Se deve verificar o certificado SSL do servidor web. Os valores poss¨ªveis s?o: 0 - (padr?o) pular verifica??o de pares; 1 - verificar par. |
| uuid | string | (somente leitura em cen¨¢rios da web j¨¢ existentes) Identificador exclusivo global, usado para vincular cen¨¢rios Web importados a cen¨¢rios j¨¢ existentes. Usado apenas para cen¨¢rios Web em modelos. |
Cen¨¢rio Web
O objeto de cen¨¢rio da web tem as seguintes propriedades.
| Propriedade | Tipo | Descri??o |
|---|---|---|
| httptestid | string | (somente leitura) ID do cen¨¢rio web. |
| hostid (requirido) |
string | ID do host ao qual o cen¨¢rio da web pertence. |
| name (requirido) |
string | Nome do cen¨¢rio web. |
| agent | string | String do agente do usu¨¢rio que ser¨¢ usada pelo cen¨¢rio web. Padr?o: Áú»¢¶Ä²© |
| authentication | integer | M¨¦todo de autentica??o que ser¨¢ usado pelo cen¨¢rio web. Valores poss¨ªveis: 0 - (padr?o) none; 1 - autentica??o HTTP b¨¢sica; 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.. Padr?o: 1m. |
| headers | array de HTTP fields | 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. 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. Os valores poss¨ªveis s?o: 0 - (padr?o) Ativado; 1 - Desativado. |
| templateid | string | (somente leitura) ID do cen¨¢rio Web do modelo pai. |
| variables | array of HTTP fields | 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. Os valores poss¨ªveis s?o: 0 - (padr?o) pular a verifica??o do host; 1 - verificar host. |
| verify_peer | integer | Se deve verificar o certificado SSL do servidor web. Os valores poss¨ªveis s?o: 0 - (padr?o) pular verifica??o de pares; 1 - verificar par. |
| uuid | string | (somente leitura em cen¨¢rios da web j¨¢ existentes) Identificador exclusivo global, usado para vincular cen¨¢rios Web importados a cen¨¢rios j¨¢ existentes. Usado apenas para cen¨¢rios Web em modelos. |
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 | Descri??o |
|---|---|---|
| httpstepid | string | (somente leitura) ID da etapa do cen¨¢rio. |
| name (requirido) |
string | Nome da etapa do cen¨¢rio. |
| no (requirido) |
integer | N¨²mero de sequ¨ºncia da etapa em um cen¨¢rio web. |
| url (requirido) |
string | URL a ser verificado. |
| follow_redirects | integer | Se deve seguir redirecionamentos HTTP. Os valores poss¨ªveis s?o: 0 - n?o siga redirecionamentos; 1 - (padr?o) seguir redirecionamentos. |
| headers | array de HTTP fields | 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 array de HTTP fields |
Vari¨¢veis ??HTTP POST como uma string (dados brutos de postagem) ou como uma matriz de HTTP fields (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. Os valores poss¨ªveis s?o: 0 - (padr?o) somente body; 1 - somente headers; 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. Padr?o: 15s. M¨¢ximo: 1h. M¨ªnimo: 1s. |
| variables | array de HTTP fields | Vari¨¢veis ??da etapa do cen¨¢rio. |
| query_fields | array de HTTP fields | Campos de consulta - array de HTTP fields que ser¨¢ adicionado ao URL ao realizar uma solicita??o |
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 | Descri??o |
|---|---|---|
| name (required) |
string | Nome do cabe?alho / vari¨¢vel / Campo POST ou GET. |
| value (required) |
string | Valor do cabe?alho / vari¨¢vel / Campo POST ou GET. |