Saves the auto-update package cleanup policy settings

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

Configures the cleanup policy for auto-update packages including enabling/disabling cleanup and specifying the number of recent package versions to retain.

Request URL

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

Scope

DesktopCentralCloud.SWDeployment.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Request Body

application/json
JSON Object
Hide Sub-Attributes
isEnableAutoUpdateCleanupbooleanOptional

true to enable auto-update package cleanup, false to disable

noOfRecentAutoUpdatePkgsintegerOptional

Number of recent auto-update package versions to retain per software (2-8)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/swDeployment/savePackageCleanupSettings \
  --header 'Accept: application/savePackageCleanup.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/savePackageCleanup.v1+json' \
  --data '{}'

Sample Request Body

Enable cleanup, keep 3 recent

Copied!
  {
    "noOfRecentAutoUpdatePkgs": 3,
    "isEnableAutoUpdateCleanup": true
  }
                
Show full

Disable cleanup

Copied!
  {
    "noOfRecentAutoUpdatePkgs": 2,
    "isEnableAutoUpdateCleanup": false
  }
                
Show full

Response Parameters

- HTTP code 200

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

Human-readable result message

- HTTP code 500

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

SW_INTERNAL_ERROR for cleanup settings failures, INTERNAL_ERROR for restore operation errors

errorMessagestring

Internal server error with details about the cleanup policy or archive restore failure

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Settings saved

Copied!
  {
    "remarks": "Package Cleanup Settings SuccessFully Updated"
  }
                
Show full

Sample Response: HTTP 500

Server error

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