List every script in the Script Repository

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns every script in the Script Repository that is visible to the logged-in user. Use the returned scriptId when creating a Custom Script configuration policy with executionType Repository.

Request URL

https://{serverurl}/dcapi/configuration/scripts Copied!

Scope

DesktopCentralCloud.Common.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/scripts.v1+jsonapplication/scripts.v1+jsonCopied!

- Query Parameters

platformstringOptional

Restrict the list to one platform. Allowed values:
Windows
Mac
Linux
All
The value is not case sensitive

Default: All

offsetintegerOptional

Zero-based index of the first script to return. Use it with limit to page through the list. Default: 0

limitintegerOptional

Number of scripts to return in one page. Allowed values: 1 to 1000. Default: 30

filterstringOptional

Return only scripts whose file name contains this text. The match is case insensitive. Default: no filter

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/configuration/scripts \
  --header 'Accept: application/scripts.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Array

A single script summary entry

Hide Sub-Attributes
JSON Object
Show Sub-Attributes
scriptIdlong

Unique script ID. Pass it as scriptId when creating a Custom Script configuration policy with executionType repository

scriptNamestring

Filename of the script

platformIDinteger

Platform the script targets. Allowed values:
1 = Windows
2 = Mac
3 = Linux

scriptArgumentsstring

Default command-line arguments stored with the script. Decrypted before it is returned for Windows scripts. Empty when no arguments were saved

isDynamicArgsPresentboolean

true when a dynamic argument JSON file is associated with the script

exitCodesstring

Exit codes treated as success. Comma-separated list; scripts created before multi-exit-code support return a single numeric code

descriptionstring

Description of the script

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Product error code for the authorization failure

errorMsgstring

Localised error message for the error code

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Product error code for the failure

errorMsgstring

Localised error message for the error code

Sample Response: HTTP 200

Paginated list of scripts filtered by platform

Copied!
  [
    {
      "scriptId": 12345,
      "isDynamicArgsPresent": false,
      "scriptArguments": "--timezone IST",
      "scriptName": "ChangeTimeZone.bat",
      "exitCodes": "0,1",
      "description": "Batch Script to change timezone",
      "platformID": 1
    },
    {
      "scriptId": 12346,
      "isDynamicArgsPresent": false,
      "scriptArguments": "",
      "scriptName": "CleanTempFiles.sh",
      "exitCodes": "0",
      "description": "Shell script to clean temp files",
      "platformID": 3
    }
  ]
                
▼ Show full

Sample Response: HTTP 401

The API user does not have the role required for this operation

Copied!
  {
    "errorCode": 1001,
    "errorMsg": "Access denied - You are not allowed to access the requested resource."
  }
                
▼ Show full

Sample Response: HTTP 500

Unexpected server error while listing scripts

Copied!
  {
    "errorCode": 50001,
    "errorMsg": "An Internal Error occurred, try again later."
  }
                
▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.