[comment]: # aside: 1

[comment]: # ({43284bfe-8b1700c1})
# Объект script

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

[comment]: # ({/43284bfe-8b1700c1})

[comment]: # ({1c7e0362-9c6db006})
### Скрипт

Объект script имеет следующие свойства.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|scriptid|ID|ID скрипта.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*<br>- *обязательно* для операций обновления|
|name|string|Имя скрипта.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *обязательно* для операций создания|
|type|integer|Тип скрипта.<br><br>Допустимые значения, если `scope` установлен в "action operation":<br>0 - Script;<br>1 - IPMI;<br>2 - SSH;<br>3 - TELNET;<br>5 - Webhook.<br><br>Допустимые значения, если `scope` установлен в "manual host action" или "manual event action":<br>6 - URL.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *обязательно* для операций создания|
|command|string|Команда для выполнения.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *обязательно*, если `type` установлен в "Script", "IPMI", "SSH", "TELNET" или "Webhook"|
|scope|integer|Область применения скрипта.<br><br>Допустимые значения:<br>1 - action operation;<br>2 - manual host action;<br>4 - manual event action.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *обязательно* для операций создания|
|execute\_on|integer|Где запускать скрипт.<br><br>Допустимые значения:<br>0 - запуск на агенте Zabbix;<br>1 - запуск на сервере Zabbix. *Поддерживается* только если на сервере Zabbix включено выполнение глобальных скриптов;<br>2 - *(по умолчанию)* запуск на сервере Zabbix или прокси.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `type` установлен в "Script"|
|menu\_path|string|Папки, разделенные слешем, которые формируют навигацию в стиле меню во веб-интерфейсе при нажатии на узел сети или событие.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `scope` установлен в "manual host action" или "manual event action"|
|authtype|integer|Метод аутентификации, используемый для скрипта типа SSH.<br><br>Допустимые значения:<br>0 - пароль;<br>1 - публичный ключ.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `type` установлен в "SSH"|
|username|string|Имя пользователя, используемое для аутентификации.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *обязательно*, если `type` установлен в "SSH" или "TELNET"|
|password|string|Пароль, используемый для скриптов SSH с аутентификацией по паролю и для скриптов TELNET.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `type` установлен в "SSH" и `authtype` установлен в "password", или если `type` установлен в "TELNET"|
|publickey|string|Имя файла публичного ключа, используемого для скриптов SSH с аутентификацией по публичному ключу.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *обязательно*, если `type` установлен в "SSH" и `authtype` установлен в "public key"|
|privatekey|string|Имя файла закрытого ключа, используемого для скриптов SSH с аутентификацией по публичному ключу.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *обязательно*, если `type` установлен в "SSH" и `authtype` установлен в "public key"|
|port|string|Номер порта, используемый для скриптов SSH и TELNET.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `type` установлен в "SSH" или "TELNET"|
|groupid|ID|ID группы узлов сети, на которых можно запускать скрипт.<br><br>Если установлено значение "0", скрипт будет доступен для всех групп узлов сети.<br><br>По умолчанию: 0.|
|usrgrpid|ID|ID группы пользователей, которым будет разрешено запускать скрипт.<br><br>Если установлено значение "0", скрипт будет доступен для всех групп пользователей.<br><br>По умолчанию: 0.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `scope` установлен в "manual host action" или "manual event action"|
|host\_access|integer|Права на узел сети, необходимые для запуска скрипта.<br><br>Допустимые значения:<br>2 - *(по умолчанию)* чтение;<br>3 - запись.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `scope` установлен в "manual host action" или "manual event action"|
|confirmation|string|Текст всплывающего окна подтверждения.<br>Всплывающее окно появится при попытке запустить скрипт из веб-интерфейса Zabbix.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `scope` установлен в "manual host action" или "manual event action"|
|timeout|string|Тайм-аут выполнения скрипта webhook в секундах. Поддерживаются суффиксы единиц времени (например, 30s, 1m).<br><br>Допустимые значения: 1-60s.<br><br>По умолчанию: 30s.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *обязательно*, если `type` установлен в "Webhook"|
|parameters|array|Массив [входных параметров webhook](/manual/api/reference/script/object#webhook-parameters).<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `type` установлен в "Webhook"|
|description|string|Описание скрипта.|
|url|string|Пользовательский URL.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *обязательно*, если `type` установлен в "URL"|
|new_window|integer|Открывать URL в новом окне.<br><br>Допустимые значения:<br>0 - Нет;<br>1 - *(по умолчанию)* Да.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `type` установлен в "URL"|
|manualinput|integer|Указывает, принимает ли скрипт ввод, предоставленный пользователем.<br><br>Допустимые значения:<br>0 - *(по умолчанию)* Отключено;<br>1 - Включено;<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `scope` установлен в "manual host action" или "manual event action"|
|manualinput_prompt|string|Текст запроса для ручного ввода.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *обязательно*, если `manualinput` установлен в "Enabled"|
|manualinput_validator|string|Строковое поле, используемое для проверки введенных пользователем данных. Строка состоит либо из регулярного выражения, либо из набора значений, разделенных запятыми.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *обязательно*, если `manualinput` установлен в "Enabled"|
|manualinput_validator_type|integer|Определяет тип ожидаемого пользовательского ввода.<br><br>Допустимые значения:<br>0 - *(по умолчанию)* String. Указывает, что manualinput_validator следует трактовать как регулярное выражение;<br>1 - List. Указывает, что manualinput_validator следует трактовать как список возможных значений ввода, разделенных запятыми.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `manualinput` установлен в "Enabled"|
|manualinput_default_value|string|Значение по умолчанию для автоматического заполнения пользовательского ввода.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *поддерживается*, если `manualinput_validator_type` установлен в "String"|

[comment]: # ({/1c7e0362-9c6db006})

[comment]: # ({4ab66f57-05b0e37d})
#### Параметры вебхука

Параметры, передаваемые в скрипт вебхука при его вызове, имеют следующие
свойства.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|name|string|Имя параметра.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|value|string|Значение параметра. Поддерживает [макросы](/manual/appendix/macros/supported_by_location).|

[comment]: # ({/4ab66f57-05b0e37d})

[comment]: # ({0ba46586-587d2fd0})
### Отладка

Отладочная информация о выполненном скрипте вебхука. Объект debug имеет
следующие свойства.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|logs|array|Массив [записей журнала](/manual/api/reference/script/object#log-entry).|
|ms|string|Длительность выполнения скрипта в миллисекундах.|

[comment]: # ({/0ba46586-587d2fd0})

[comment]: # ({f7a09e87-8ea23127})
#### Запись журнала

Объект записи журнала имеет следующие свойства.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|level|integer|Уровень журнала.|
|ms|string|Время, прошедшее в миллисекундах с момента запуска скрипта до добавления записи журнала.|
|message|string|Сообщение журнала.|

[comment]: # ({/f7a09e87-8ea23127})