# > Объект веб-сценария

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

### Веб-сценарий

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

|Свойство|Тип|Описание|
|----------------|------|----------------|
|httptestid|строка|*(только чтение)* ID веб-сценария.|
|**hostid**<br>(требуется)|строка|ID узла сети, которому принадлежит веб-сценарий.|
|**name**<br>(требуется)|строка|Имя веб-сценария.|
|agent|строка|Строка агента клиента, которая используется веб-сценарием.<br><br>По умолчанию: Zabbix|
|applicationid|строка|ID группы элементов данных, которой принадлежит веб-сценарий.|
|authentication|целое число|Метод аутентификации, который используется веб-сценарием.<br><br>Возможные значения:<br>0 - *(по умолчанию)* нет;<br>1 - простая HTTP аутентификация;<br>2 - NTLM аутентификация.|
|delay|строка|Интервал выполнения веб-сценария. Принимает секунды, единицы времени с суффиксом и пользовательские макросы.<br><br>По умолчанию: 1m.|
|headers|массив [полей HTTP](/ru/manual/api/reference/httptest/object#поле_HTTP)|Заголовки HTTP, которые будут отправлены при выполнении запроса.|
|http\_password|строка|Пароль используемый для простой HTTP или NTLM аутентификациями.|
|http\_proxy|строка|Прокси, который используется веб-сценарием, задается в виде *http://\[имя пользователя\[:пароль\]@\]proxy.example.com\[:порт\]*.|
|http\_user|строка|Имя пользователя используемое для простой HTTP или NTLM аутентификациями.|
|nextcheck|штамп времени|*(только чтение)* Время следующего выполнения веб-сценария.|
|retries|целое число|Сколько раз веб-сценарий будет пытаться выполнять каждый шаг до ошибки.<br><br>По умолчанию: 1.|
|ssl\_cert\_file|строка|Имя файла SSL сертификата, который используется для аутентификации клиента (должен быть в PEM формате).|
|ssl\_key\_file|строка|Имя файла приватного ключа SSL, который используется для аутентификации клиента (должен быть в PEM формате).|
|ssl\_key\_password|строка|Пароль к приватному ключу SSL.|
|status|целое число|Активирован ли веб-сценарий.<br><br>Возможные значения:<br>0 - *(по умолчанию)* активирован;<br>1 - деактивирован.|
|templateid|строка|*(только чтение)* ID родительского веб-сценария из шаблона.|
|variables|массив [полей HTTP](/ru/manual/api/reference/httptest/object#поле_HTTP)|Переменные веб-сценария.|
|verify\_host|целое число|Необходимо ли проверять, что имя хоста, который указан в SSL сертификате совпадает с указанным в сценарии.<br><br>Возможные значения:<br>0 - *(по умолчанию)* пропускать проверку хоста;<br>1 - проверять хост.|
|verify\_peer|целое число|Необходимо ли проверять SSL сертификат веб-сервера.<br><br>Возможные значения:<br>0 - *(по умолчанию)* пропускать проверку клиента;<br>1 - проверять клиента.|

### Шаг сценария

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

|Свойство|Тип|Описание|
|----------------|------|----------------|
|httpstepid|строка|*(только чтение)* ID шага сценария.|
|**name**<br>(требуется)|строка|Имя шага сценария.|
|**no**<br>(требуется)|целое число|Порядковый номер шага в веб-сценарии.|
|**url**<br>(требуется)|строка|Проверяемый URL.|
|follow\_redirects|целое число|Необходимо ли следовать HTTP перенаправлениям.<br><br>Возможные значения:<br>0 - не следовать перенаправлениям;<br>1 - *(по умолчанию)* следовать перенаправлениям.|
|headers|массив [полей HTTP](/ru/manual/api/reference/httptest/object#поле_HTTP)|Заголовки HTTP, которые будут отправлены при выполнении запроса. Заголовки на уровне шага сценария переопределяют заголовки, которые указаны для веб-сценария.|
|httptestid|строка|*(только чтение)* ID веб-сценария, которому принадлежит шаг.|
|posts|строка *устарело*<br>массив [полей HTTP](/ru/manual/api/reference/httptest/object#поле_HTTP)|Переменные HTTP POST в виде строки (сырые post данные) или в виде массива [полей HTTP](/ru/manual/api/reference/httptest/object#поле_HTTP) (данные полей формы).|
|required|строка|Текст, который должен присутствовать в ответе.|
|retrieve\_mode|целое число|Часть HTTP ответа, которую должен получить шаг сценария.<br><br>Возможные значения:<br>0 - *(по умолчанию)* только тело;<br>1 - только заголовки;<br>2 - заголовки и тело.|
|status\_codes|строка|Диапазоны требуемых кодов состояний HTTP, разделенные запятыми.|
|timeout|строка|Время ожидания ответа на запрос в секундах. Принимает секунды, единицы времени с суффиксами и пользовательские макросы.<br><br>По умолчанию: 15s.|
|variables|массив [полей HTTP](/ru/manual/api/reference/httptest/object#поле_HTTP)|Переменные шага сценария.|
|query\_fields|массив [полей HTTP](/ru/manual/api/reference/httptest/object#поле_HTTP)|Поля запроса - массив [полей HTTP](/ru/manual/api/reference/httptest/object#поле_HTTP), которые добавятся к URL при выполнении запроса|

### Поле HTTP

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

|Свойство|Тип|Описание|
|----------------|------|----------------|
|**name**<br>(требуется)|строка|Имя заголовка / переменной / полей POST или GET.|
|**value**<br>(требуется)|строка|Значение заголовка / переменной / полей POST или GET.|