[comment]: # aside: 1

[comment]: # ({b751c407-a17bb95b})
# Objet de scénario web

Les objets suivants sont directement liés à l'API `webcheck`.

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

[comment]: # ({24442f22-e60908bb})
### Scénario web

L'objet scénario web possède les propriétés suivantes.

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|httptestid|ID|ID du scénario web.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *lecture seule*<br>- *obligatoire* pour les opérations de mise à jour|
|hostid|ID|ID de l'hôte auquel appartient le scénario web.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *constant*<br>- *obligatoire* pour les opérations de création|
|name|string|Nom du scénario web.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* pour les opérations de création|
|agent|string|Chaîne user agent qui sera utilisée par le scénario web.<br><br>Par défaut : Zabbix|
|authentication|integer|Méthode d'authentification qui sera utilisée par le scénario web.<br><br>Valeurs possibles :<br>0 - *(par défaut)* aucune ;<br>1 - authentification HTTP basique ;<br>2 - authentification NTLM ;<br>3 - authentification Kerberos ;<br>4 - authentification Digest.|
|delay|string|Intervalle d'exécution du scénario web.<br><br>Accepte des secondes ou une unité de temps avec suffixe (par exemple, 30s, 1m, 2h, 1d), ou une macro utilisateur.<br><br>Par défaut : 1m.|
|headers|array|[En-têtes HTTP](/manual/api/reference/httptest/object#http-field) qui seront envoyés lors de l'exécution d'une requête.|
|http\_password|string|Mot de passe utilisé pour l'authentification HTTP basique, NTLM, Kerberos ou Digest.|
|http\_proxy|string|Proxy qui sera utilisé par le scénario web, indiqué sous la forme *http://\[username\[:password\]@\]proxy.example.com\[:port\]*.|
|http\_user|string|Nom d'utilisateur utilisé pour l'authentification HTTP basique, NTLM, Kerberos ou Digest.|
|retries|integer|Nombre de fois qu'un scénario web tentera d'exécuter chaque étape avant d'échouer.<br><br>Par défaut : 1.|
|ssl\_cert\_file|string|Nom du fichier de certificat SSL utilisé pour l'authentification du client (doit être au format PEM).|
|ssl\_key\_file|string|Nom du fichier de clé privée SSL utilisé pour l'authentification du client (doit être au format PEM).|
|ssl\_key\_password|string|Mot de passe de la clé privée SSL.|
|status|integer|Indique si le scénario web est activé.<br><br>Valeurs possibles :<br>0 - *(par défaut)* activé ;<br>1 - désactivé.|
|templateid|ID|ID du scénario web du modèle parent.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *lecture seule*|
|variables|array|[Variables](/manual/api/reference/httptest/object#http-field) du scénario web.|
|verify\_host|integer|Indique s'il faut valider que le nom d'hôte de la connexion correspond à celui figurant dans le certificat de l'hôte.<br><br>Valeurs possibles :<br>0 - *(par défaut)* ignorer la vérification de l'hôte ;<br>1 - vérifier l'hôte.|
|verify\_peer|integer|Indique s'il faut valider que le certificat de l'hôte est authentique.<br><br>Valeurs possibles :<br>0 - *(par défaut)* ignorer la vérification du pair ;<br>1 - vérifier le pair.|
|uuid|string|Identifiant unique global, utilisé pour lier les scénarios web importés à ceux qui existent déjà. Généré automatiquement s'il n'est pas fourni.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si le scénario web appartient à un modèle|

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

[comment]: # ({dcde4da9-eb20f47d})
### Étape du scénario

L'objet étape du scénario définit une vérification spécifique de scénario web. Il possède les propriétés suivantes.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|name|string|Nom de l'étape du scénario.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|no|integer|Numéro séquentiel de l'étape dans un scénario web.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|url|string|URL à vérifier.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|follow\_redirects|integer|Indique s'il faut suivre les redirections HTTP.<br><br>Valeurs possibles :<br>0 - ne pas suivre les redirections ;<br>1 - *(par défaut)* suivre les redirections.|
|headers|array|[En-têtes HTTP](/manual/api/reference/httptest/object#http-field) qui seront envoyés lors de l'exécution d'une requête. Les en-têtes de l'étape du scénario remplaceront les en-têtes spécifiés pour le scénario web.|
|posts|string/array|Variables HTTP POST sous forme de chaîne (données POST brutes) ou de tableau de [champs HTTP](/manual/api/reference/httptest/object#http-field) (données de champs de formulaire).|
|required|string|Texte qui doit être présent dans la réponse.|
|retrieve\_mode|integer|Partie de la réponse HTTP que l'étape du scénario doit récupérer.<br><br>Valeurs possibles :<br>0 - *(par défaut)* corps uniquement ;<br>1 - en-têtes uniquement ;<br>2 - en-têtes et corps.|
|status\_codes|string|Plages de codes de statut HTTP requis, séparées par des virgules.|
|timeout|string|Délai d'attente de la requête en secondes. Accepte des secondes, une unité de temps avec suffixe, ou une macro utilisateur.<br><br>Par défaut : 15s. Maximum : 1h. Minimum : 1s.|
|variables|array|[Variables](/manual/api/reference/httptest/object#http-field) de l'étape du scénario.|
|query\_fields|array|Champs de requête - tableau de [champs HTTP](/manual/api/reference/httptest/object#http-field) qui seront ajoutés à l'URL lors de l'exécution d'une requête.|

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

[comment]: # ({75483b8b-d69e8b7b})
#### Champ HTTP

L'objet champ HTTP définit le nom et la valeur utilisés pour spécifier les variables du scénario web, les en-têtes HTTP, ainsi que les champs POST ou les champs de requête.
Il possède les propriétés suivantes.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|name|string|Nom de l'en-tête/de la variable/du champ POST ou GET.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire*|
|value|string|Valeur de l'en-tête/de la variable/du champ POST ou GET.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire*|

[comment]: # ({/75483b8b-d69e8b7b})

[comment]: # ({ec1bbb32-c7ab7fb0})
### Balise de scénario web

L'objet balise de scénario web possède les propriétés suivantes.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|tag|string|Nom de la balise du scénario web.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|value|string|Valeur de la balise du scénario web.|

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