Manage Scripts

Creates and deletes a script and gets a list of scripts for a category.

A list of scripts is retrieved within a category.

Path Parameters

tenantIdstringrequired
Describes the client ID or msp ID of the tenant. See "Getting Started" guide
categoryIdstringrequired
Defined category id

Loading Examples...

When creating a script:

Attachment files must be converted to byte stream and base64-encoded. Always include a name and file.
To get the list of available categories, invoke the Get Categories endpoint.

tenantIdstringrequired
Describes the client ID or msp ID of the tenant. See "Getting Started" guide
categoryIdstringrequired
Defined category id

application/json

namestring
Script name.
descriptionstring
Description for the script.
platformsarray of strings
OS platforms.Example: WINDOWS, LINUX
executionTypestring
Script execution type.Supported Values: BATCHFILE, COMMAND, DOWNLOAD, EXE, MSI, POWERSHELL, PYTHON, PERL, PHP, SHELL, VBS
Enum:
BATCHFILECOMMANDDOWNLOADEXEMSIPOWERSHELLPYTHONPERLPHPSHELLVBS
installTimeoutinteger
Maximum time for installation.
registryPathstring
Registry path for sanity check after execution.
registryValuestring
Registry Value for sanity check after execution.
processNamestring
Process name for sanity check.
serviceNamestring
Service name for sanity check.
attachmentobject
If executionType is COMMAND, then command is needed else attachment file is needed.
parametersarray
Parameter data.
commandstring
outputDirectorystring
Output directory supported required only when executionType is DOWNLOAD, EXE, MSI.
outputFilestring
Output file supported required only when executionType is DOWNLOAD, EXE, MSI.

Loading Examples...

Loading Examples...

Partners can delete client or partner scripts. A client can only delete client-specific scripts.

tenantIdstringrequired
Describes the client ID or msp ID of the tenant. See "Getting Started" guide
categoryIdstringrequired
Defined category id