[comment]: # aside: 1

[comment]: # translation:outdated

[comment]: # ({87765175-a17bb95b})
# > Webscenario-object

De volgende objecten zijn direct gerelateerd aan de `webcheck` API.

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

[comment]: # ({daeaf60c-e60908bb})
### Web scenario

The web scenario object has the following properties.

|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|httptestid|string|ID of the web scenario.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *read-only*<br>- *required* for update operations|
|hostid|string|ID of the host that the web scenario belongs to.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *constant*<br>- *required* for create operations|
|name|string|Name of the web scenario.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *required* for create operations|
|agent|string|User agent string that will be used by the web scenario.<br><br>Default: Zabbix|
|authentication|integer|Authentication method that will be used by the web scenario.<br><br>Possible values:<br>0 - *(default)* none;<br>1 - basic HTTP authentication;<br>2 - NTLM authentication.|
|delay|string|Execution interval of the web scenario.<br>Accepts seconds, time unit with suffix, or a user macro.<br><br>Default: 1m.|
|headers|array|[HTTP headers](/manual/api/reference/httptest/object#http-field) that will be sent when performing a request.|
|http\_password|string|Password used for basic HTTP or NTLM authentication.|
|http\_proxy|string|Proxy that will be used by the web scenario given as *http://\[username\[:password\]@\]proxy.example.com\[:port\]*.|
|http\_user|string|User name used for basic HTTP or NTLM authentication.|
|retries|integer|Number of times a web scenario will try to execute each step before failing.<br><br>Default: 1.|
|ssl\_cert\_file|string|Name of the SSL certificate file used for client authentication (must be in PEM format).|
|ssl\_key\_file|string|Name of the SSL private key file used for client authentication (must be in PEM format).|
|ssl\_key\_password|string|SSL private key password.|
|status|integer|Whether the web scenario is enabled.<br><br>Possible values:<br>0 - *(default)* enabled;<br>1 - disabled.|
|templateid|string|ID of the parent template web scenario.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *read-only*|
|variables|array|Web scenario [variables](/manual/api/reference/httptest/object#http-field).|
|verify\_host|integer|Whether to verify that the host name specified in the SSL certificate matches the one used in the scenario.<br><br>Possible values:<br>0 - *(default)* skip host verification;<br>1 - verify host.|
|verify\_peer|integer|Whether to verify the SSL certificate of the web server.<br><br>Possible values:<br>0 - *(default)* skip peer verification;<br>1 - verify peer.|
|uuid|string|Global unique identifier, used for linking imported web scenarios to already existing ones. Auto-generated, if not given.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *supported* if the web scenario belongs to a template|

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

[comment]: # ({550e6dd8-eb20f47d})
### Scenariostap

Het object scenariostap definieert een specifieke controle in een webscenario. Het heeft de volgende eigenschappen.

|Eigenschap|[Type](/handleiding/api/referentie_commentaar#gegevenstypen)|Beschrijving|
|--|--|------|
|name|string|Naam van de scenariostap.<br><br>[Eigenschapsgedrag](/handleiding/api/referentie_commentaar#eigenschapsgedrag):<br>- *vereist*|
|no|integer|Volgnummer van de stap in een webscenario.<br><br>[Eigenschapsgedrag](/handleiding/api/referentie_commentaar#eigenschapsgedrag):<br>- *vereist*|
|url|string|URL die moet worden gecontroleerd.<br><br>[Eigenschapsgedrag](/handleiding/api/referentie_commentaar#eigenschapsgedrag):<br>- *vereist*|
|follow\_redirects|integer|Of HTTP-omleidingen moeten worden gevolgd.<br><br>Mogelijke waarden:<br>0 - omleidingen niet volgen;<br>1 - *(standaard)* omleidingen volgen.|
|headers|array|[HTTP-headers](/handleiding/api/referentie/httptest/object#http-field) die worden verzonden bij het uitvoeren van een aanvraag. Scenariostap-headers zullen headers overschrijven die zijn gespecificeerd voor het webscenario.|
|posts|string/array|HTTP POST-variabelen als een string (ruwe postdata) of als een array van [HTTP-velden](/handleiding/api/referentie/httptest/object#http-field) (formuliergegevens).|
|required|string|Tekst die aanwezig moet zijn in het antwoord.|
|retrieve\_mode|integer|Deel van het HTTP-antwoord dat de scenariostap moet ophalen.<br><br>Mogelijke waarden:<br>0 - *(standaard)* alleen de body;<br>1 - alleen headers;<br>2 - headers en body.|
|status\_codes|string|Reeksen vereiste HTTP-statuscodes, gescheiden door komma's.|
|timeout|string|Aanvraagtime-out in seconden. Accepteert seconden, tijdeenheid met suffix of een gebruikersmacro.<br><br>Standaard: 15s. Maximum: 1u. Minimum: 1s.|
|variables|array|Scenariostap [variabelen](/handleiding/api/referentie/httptest/object#http-field).|
|query\_fields|array|Query-velden - array van [HTTP-velden](/handleiding/api/referentie/httptest/object#http-field) die aan de URL worden toegevoegd bij het uitvoeren van een aanvraag.|

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

[comment]: # ({10a55bc3-d69e8b7b})
### HTTP-veld

Het object HTTP-veld definieert de naam en de waarde die wordt gebruikt om de webscenario-variabelen, HTTP-headers en POST- of queryvelden op te geven. Het heeft de volgende eigenschappen.

|Eigenschap|[Type](/handleiding/api/referentie_commentaar#gegevenstypen)|Beschrijving|
|--|--|------|
|name|string|Naam van header/variabele/POST- of GET-veld.<br><br>[Eigenschapsgedrag](/handleiding/api/referentie_commentaar#eigenschapsgedrag):<br>- *vereist*|
|value|string|Waarde van header/variabele/POST- of GET-veld.<br><br>[Eigenschapsgedrag](/handleiding/api/referentie_commentaar#eigenschapsgedrag):<br>- *vereist*|

[comment]: # ({/10a55bc3-d69e8b7b})

[comment]: # ({0a47168c-c7ab7fb0})
### Webscenario-tag

Het object webscenario-tag heeft de volgende eigenschappen.

|Eigenschap|[Type](/handleiding/api/referentie_commentaar#gegevenstypen)|Beschrijving|
|--|--|------|
|tag|string|Naam van de webscenario-tag.<br><br>[Eigenschapsgedrag](/handleiding/api/referentie_commentaar#eigenschapsgedrag):<br>- *vereist*|
|value|string|Waarde van de webscenario-tag.|

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