[comment]: # aside: 1

[comment]: # ({b751c407-a17bb95b})
# Объект веб-сценария

Следующие объекты напрямую связаны с API `webcheck`.

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

[comment]: # ({24442f22-e60908bb})
### Веб-сценарий

Объект веб-сценария имеет следующие свойства.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|httptestid|ID|ID веб-сценария.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*<br>- *обязательно* для операций обновления|
|hostid|ID|ID узла сети, которому принадлежит веб-сценарий.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *константа*<br>- *обязательно* для операций создания|
|name|string|Имя веб-сценария.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *обязательно* для операций создания|
|agent|string|Строка user agent, которая будет использоваться веб-сценарием.<br><br>По умолчанию: Zabbix|
|authentication|integer|Метод аутентификации, который будет использоваться веб-сценарием.<br><br>Возможные значения:<br>0 - *(по умолчанию)* нет;<br>1 - базовая HTTP-аутентификация;<br>2 - аутентификация NTLM;<br>3 - аутентификация Kerberos;<br>4 - аутентификация Digest.|
|delay|string|Интервал выполнения веб-сценария.<br><br>Принимает секунды или единицу времени с суффиксом (например, 30s, 1m, 2h, 1d), либо пользовательский макрос.<br><br>По умолчанию: 1m.|
|headers|array|[HTTP-заголовки](/manual/api/reference/httptest/object#http-field), которые будут отправляться при выполнении запроса.|
|http\_password|string|Пароль, используемый для базовой HTTP-аутентификации, NTLM, Kerberos или Digest-аутентификации.|
|http\_proxy|string|Прокси, который будет использоваться веб-сценарием, в виде *http://\[username\[:password\]@\]proxy.example.com\[:port\]*.|
|http\_user|string|Имя пользователя, используемое для базовой HTTP-аутентификации, NTLM, Kerberos или Digest-аутентификации.|
|retries|integer|Количество попыток, которые веб-сценарий выполнит для каждого шага перед сбоем.<br><br>По умолчанию: 1.|
|ssl\_cert\_file|string|Имя файла SSL-сертификата, используемого для аутентификации клиента (должен быть в формате PEM).|
|ssl\_key\_file|string|Имя файла закрытого ключа SSL, используемого для аутентификации клиента (должен быть в формате PEM).|
|ssl\_key\_password|string|Пароль закрытого ключа SSL.|
|status|integer|Включен ли веб-сценарий.<br><br>Возможные значения:<br>0 - *(по умолчанию)* включен;<br>1 - отключен.|
|templateid|ID|ID родительского шаблона веб-сценария.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*|
|variables|array|[Переменные](/manual/api/reference/httptest/object#http-field) веб-сценария.|
|verify\_host|integer|Следует ли проверять, что имя узла для соединения совпадает с именем в сертификате узла.<br><br>Возможные значения:<br>0 - *(по умолчанию)* пропустить проверку узла;<br>1 - проверять узел.|
|verify\_peer|integer|Следует ли проверять, что сертификат узла является подлинным.<br><br>Возможные значения:<br>0 - *(по умолчанию)* пропустить проверку peer;<br>1 - проверять peer.|
|uuid|string|Глобальный уникальный идентификатор, используемый для связывания импортированных веб-сценариев с уже существующими. Если не указан, генерируется автоматически.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если веб-сценарий принадлежит шаблону|

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

[comment]: # ({dcde4da9-eb20f47d})
### Шаг сценария

Объект шага сценария определяет конкретную проверку веб-сценария. Он имеет
следующие свойства.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|name|string|Имя шага сценария.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|no|integer|Порядковый номер шага в веб-сценарии.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|url|string|URL для проверки.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|follow\_redirects|integer|Следует ли выполнять HTTP-перенаправления.<br><br>Возможные значения:<br>0 - не следовать перенаправлениям;<br>1 - *(по умолчанию)* следовать перенаправлениям.|
|headers|array|[HTTP-заголовки](/manual/api/reference/httptest/object#http-field), которые будут отправлены при выполнении запроса. Заголовки шага сценария будут переопределять заголовки, указанные для веб-сценария.|
|posts|string/array|Переменные HTTP POST в виде строки (сырые данные POST) или массива [HTTP-полей](/manual/api/reference/httptest/object#http-field) (данные полей формы).|
|required|string|Текст, который должен присутствовать в ответе.|
|retrieve\_mode|integer|Часть HTTP-ответа, которую должен получить шаг сценария.<br><br>Возможные значения:<br>0 - *(по умолчанию)* только тело;<br>1 - только заголовки;<br>2 - заголовки и тело.|
|status\_codes|string|Диапазоны требуемых HTTP-кодов состояния, разделенные запятыми.|
|timeout|string|Тайм-аут запроса в секундах. Принимает секунды, единицу времени с суффиксом или пользовательский макрос.<br><br>По умолчанию: 15s. Максимум: 1h. Минимум: 1s.|
|variables|array|[Переменные](/manual/api/reference/httptest/object#http-field) шага сценария.|
|query\_fields|array|Поля запроса - массив [HTTP-полей](/manual/api/reference/httptest/object#http-field), которые будут добавлены к URL при выполнении запроса.|

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

[comment]: # ({75483b8b-d69e8b7b})
#### Поле HTTP

Объект поля HTTP определяет имя и значение, которые используются для указания переменных веб-сценария, HTTP-заголовков, а также полей POST или полей запроса.
Он имеет следующие свойства.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|name|string|Имя заголовка/переменной/поля POST или GET.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|value|string|Значение заголовка/переменной/поля POST или GET.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *required*|

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

[comment]: # ({ec1bbb32-c7ab7fb0})
### Тег веб-сценария

Объект тега веб-сценария имеет следующие свойства.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|tag|string|Имя тега веб-сценария.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *обязательно*|
|value|string|Значение тега веб-сценария.|

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