Zabbix Documentation 2.0

2.23.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.43.23.4

User Tools

Site Tools


Sidebar

manual:appendix:api:webcheck:definitions

> Web scenario object

The following objects are directly related to the webcheck API.

Web scenario

The web scenario object has the following properties.

Property Type Description
httptestid string (readonly) ID of the web scenario.
applicationid
(required)
string ID of the application that the web scenario belongs to.
name
(required)
string Name of the web scenario.
agent string User agent string that will be used by the web scenario.
authentication integer Authentication method that will be used by the web scenario.

Possible values:
0 - (default) none;
1 - basic HTTP authentication;
2 - NTLM authentication.
delay integer Execution interval of the web scenario in seconds.

Default: 60.
http_password string Password used for authentication.

Required for web scenarios with basic HTTP or NTLM authentication.
http_user string User name used for authentication.

Required for web scenarios with basic HTTP or NTLM authentication.
macros string Web scenario variables.
nextcheck timestamp (readonly) Time of the next web scenario execution.
status integer Whether the web scenario is enabled.

Possible values are:
0 - (default) enabled;
1 - disabled.

Scenario step

The scenario step object defines a specific web scenario check. It has the following properties.

Property Type Description
webstepid string (readonly) ID of the scenario step.
name
(required)
string Name of the scenario step.
no
(required)
integer Sequence number of the step in a web scenario.
url
(required)
string URL to be checked.
httptestid string (readonly) ID of the web scenario that the step belongs to.
posts string HTTP POST variables as a string.
required string Text that must be present in the response.
status_codes string Ranges of required HTTP status codes separated by commas.
timeout integer Request timeout in seconds.

Default: 15.