script.update

Описание

object script.update(объект/массив scripts)

Этот метод позволяет обновлять существующие скрипты.

Этот метод доступен только пользователю с типом доступа Супер-администратор. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(object/array) Свойства скрипта, которые необходимо обновить.

Свойство scriptid должно быть определено для каждого скрипта, все остальные свойства необязательны. Будут обновлены только переданные свойства, все остальные останутся без изменений. Исключение составляет изменение свойства type с 5 (Webhook) на другое значение: свойство parameters будет очищено.

Возвращаемые значения

(object) Возвращает объект, содержащий идентификаторы обновленных скриптов в свойстве scriptids.

Примеры

Изменение команды скрипта

Измените команду скрипта на "/bin/ping -c 10 {HOST.CONN} 2>&1".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "script.update",
    "params": {
        "scriptid": "1",
        "command": "/bin/ping -c 10 {HOST.CONN} 2>&1"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "scriptids": [
            "1"
        ]
    },
    "id": 1
}

Изменение команды скрипта и добавление ручного ввода

Измените команду скрипта на "/bin/ping -c {MANUALINPUT} {HOST.CONN} 2>&1".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "script.update",
    "params": {
      "scriptid": "1",
      "command": "/bin/ping -c {MANUALINPUT} {HOST.CONN} 2>&1",
      "manualinput": "1",
      "manualinput_prompt": "Укажите количество ICMP-пакетов, которые нужно отправить с помощью команды ping",
      "manualinput_validator": "^(?:[1-9]|10)$",
      "manualinput_validator_type": "0",
      "manualinput_default_value": "10"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "scriptids": [
            "1"
        ]
    },
    "id": 1
}

Источник

CScript::update() в ui/include/classes/api/services/CScript.php.