> Web scenario object

The following objects are directly related to the webcheck API.

Web场景对象具有以下属性。

Web scenario

PropertyTypeDescription
httptestidstring(readonly) ID of the web scenario.
hostid
(required)		stringID of the host that the web scenario belongs to.
name
(required)		stringName of the web scenario.
agentstringUser agent string that will be used by the web scenario.

Default: Zabbix
applicationidstringID of the application that the web scenario belongs to.
authenticationintegerAuthentication method that will be used by the web scenario.

Possible values:
0 - (default) none;
1 - basic HTTP authentication;
2 - NTLM authentication.
delaystringExecution interval of the web scenario. Accepts seconds, time unit with suffix and user macro.

Default: 1m.
headersstring (deprecated)
array of 		HTTP headers that will be sent when performing a request.
http_passwordstringPassword used for authentication.

Required for web scenarios with basic HTTP or NTLM authentication.
http_proxystringProxy that will be used by the web scenario given as http://[username[:password]@]proxy.example.com[:port].
http_userstringUser name used for authentication.

Required for web scenarios with basic HTTP or NTLM authentication.
nextchecktimestamp(readonly) Time of the next web scenario execution.
retriesintegerNumber of times a web scenario will try to execute each step before failing.

Default: 1.
ssl_cert_filestringName of the SSL certificate file used for client authentication (must be in PEM format).
ssl_key_filestringName of the SSL private key file used for client authentication (must be in PEM format).
ssl_key_passwordstringSSL private key password.
statusintegerWhether the web scenario is enabled.

Possible values are:
0 - (default) enabled;
1 - disabled.
templateidstring(readonly) ID of the parent template web scenario.
variablesstring (deprecated)
array of 		Web scenario variables.
verify_hostintegerWhether to verify that the host name specified in the SSL certificate matches the one used in the scenario.

Possible values are:
0 - (default) skip host verification;
1 - verify host.
verify_peerintegerWhether to verify the SSL certificate of the web server.

Possible values are:
0 - (default) skip peer verification;
1 - verify peer.

场景步骤对象定义特定的Web场景检查。 它具有以下属性。

对于Web场景和Web场景步骤对象的headers和字段，都允许使用HTTP字段类型的字符串和数组。
不推荐使用 headers和 variables 的字符串数据类型，将来的版本将删除它们。

Scenario step

PropertyTypeDescription
httpstepidstring(readonly) ID of the scenario step.
name
(required)		stringName of the scenario step.
no
(required)		integerSequence number of the step in a web scenario.
url
(required)		stringURL to be checked.
follow_redirectsintegerWhether to follow HTTP redirects.

Possible values are:
0 - don’t follow redirects;
1 - (default) follow redirects.
headersstring (deprecated)
array of HTTP fields		HTTP headers that will be sent when performing a request. Scenario step headers will overwrite headers specified for the web scenario.
httptestidstring(readonly) ID of the web scenario that the step belongs to.
postsstring
array of 		HTTP POST variables as a string (raw post data) or as an array of HTTP fields (form field data).
requiredstringText that must be present in the response.
retrieve_modeintegerPart of the HTTP response that the scenario step must retrieve.

Possible values are:
0 - (default) only body;
1 - only headers.
status_codesstringRanges of required HTTP status codes separated by commas.
timeoutstringRequest timeout in seconds. Accepts seconds, time unit with suffix and user macro.

Default: 15s.
variablesstring (deprecated)
array of 		Scenario step variables.
query_fieldsarray of HTTP fieldsQuery fields - array of that will be added to URL when performing a request

Both string and array of HTTP fields types are allowed for and variables fields of both web scenario and web scenario step object.
String data type for headers and is deprecated and will be removed in future versions.

HTTP字段对象定义名称和值，用于指定查询字段数据的变量，HTTP标头，POST表单字段数据。它具有以下属性。

HTTP field

PropertyTypeDescription
name
(required)		stringName of header / variable / POST or GET field.
value
(required)		stringValue of header / variable / POST or GET field.