Documentation
Table of Contents
script.create
Description
object script.create(object/array scripts)
This method allows to create new scripts.
Parameters
(object/array) Scripts to create.
The method accepts scripts with the standard script properties.
Return values
(object) Returns an object containing the IDs of the created scripts under the scriptids property. The order of the returned IDs matches the order of the passed scripts.
Examples
Create a script
Create a script that will reboot a server. The script will require write access to the host and will display a configuration message before running in the frontend.
Request:
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "Reboot server",
"command": "reboot server 1",
"host_access": 3,
"confirmation": "Are you sure you would like to reboot the server?"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Source
CScript::create() in frontends/php/include/classes/api/services/CScript.php.
Create a custom script
Create a custom script that will reboot a server. The script will require write access to the host and will display a configuration message before running in the frontend.
Request:
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "Reboot server",
"command": "reboot server 1",
"host_access": 3,
"confirmation": "Are you sure you would like to reboot the server?",
"type": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Source
CScript::create() in ui/include/classes/api/services/CScript.php.