Enables automatic package creation for one or more software

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

Enables auto-update for specified software IDs by associating each with an auto-update policy. When enabled, new template packages are automatically created when updates are available.

Request URL

https://{serverurl}/dcapi/swDeployment/enableSWAutoUpdate

Scope

DesktopCentralCloud.SWDeployment.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/enableSWAutoUpdate.v1+jsonapplication/enableSWAutoUpdate.v1+jsonCopied!
AcceptstringMandatory
application/enableSWAutoUpdate.v1+jsonapplication/enableSWAutoUpdate.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
softwareIdlongOptional

Software ID to enable auto-update for. Obtain from the swID field in the response of the List Auto Update Eligible Software API.

policyIdlongOptional

Auto-update policy ID to associate with this software. Obtain from the policyId field in the response of the List Auto Update Policies API.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/swDeployment/enableSWAutoUpdate \
  --header 'Accept: application/enableSWAutoUpdate.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/enableSWAutoUpdate.v1+json' \
  --data '[{"softwareId":2001,"policyId":1}]'

Sample Request Body

Enable auto-update for one software with a policy

Copied!
  [
    {
      "softwareId": 2001,
      "policyId": 1
    }
  ]
                
Show full

Enable for multiple software

Copied!
  [
    {
      "softwareId": 2001,
      "policyId": 1
    },
    {
      "softwareId": 2002,
      "policyId": 2
    }
  ]
                
Show full

Response Parameters

- HTTP code 200

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

0 on success, -1 on failure

- HTTP code 401

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

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 500

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

INTERNAL_ERROR for general failures, SW_INTERNAL_ERROR for software deployment internal errors

errorMessagestring

Internal server error with details about the template/auto-update operation failure

Possible Response Codes

200HTTP code
401HTTP code
500HTTP code

Sample Response: HTTP 200

Enabled successfully

Copied!
  {
    "status": 0
  }
                
Show full

Sample Response: HTTP 401

User lacks required role

Copied!
  {
    "errorMessage": "Unauthorized access",
    "errorCode": "UAC_UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "errorMessage": "Internal Server Error",
    "errorCode": "INTERNAL_ERROR"
  }
                
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.