Retrieves the current auto-update package cleanup policy configuration

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

Fetches whether cleanup is enabled, how many recent packages to retain, and the maximum days before archived packages are permanently deleted.

Request URL

https://{server-hostname}:8383/dcapi/swDeployment/getPackageCleanupSettingDetails

Scope

SWDeployment.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/swDeployment/getPackageCleanupSettingDetails \
  --header 'Accept: application/PackageCleanupSettingDetails.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

true if auto-update package cleanup is enabled

noOfRecentAutoUpdatePkgsinteger

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

maxDaysForAllArchivePkginteger

Maximum days to retain archived packages before permanent deletion

- 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

Cleanup enabled

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

Cleanup disabled

Copied!
  {
    "noOfRecentAutoUpdatePkgs": 2,
    "maxDaysForAllArchivePkg": 90,
    "isEnableAutoUpdateCleanup": false
  }
                
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.