Retrieves a paginated list of software packages

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 software packages with optional filters for platform, search text, and pagination. Returns package metadata including name, size, license type, creator, and creation time.

Endpoints

Request URL

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

Scope

SWDeployment.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Sample Request

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

Response Parameters

- HTTP code 200

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

Total number of packages matching criteria

has_more_recordsboolean

true if more records exist beyond the current offset+limit, false otherwise

packagesJSON Array

Array of package summary entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
packageIdlong

Unique package identifier

packageNamestring

Display name of the package

platformstring

Target platform: Windows, Mac, or Linux

packageSizelong

Total size of the package in bytes

licenseTypestring

License type: Commercial or Non-Commercial

createdBystring

Username of the creator

createdTimelong

Epoch timestamp (ms) when the package was created

- HTTP code 500

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

INTERNAL_ERROR for DB query failures, SW_INTERNAL_ERROR for package operation errors

errorMessagestring

Internal server error with details about the package retrieval or execution status failure

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Paginated package list

Copied!
  {
    "has_more_records": true,
    "totalCount": 42,
    "packages": [
      {
        "licenseType": "Non-Commercial",
        "createdBy": "admin",
        "packageId": 10001,
        "createdTime": 1713264000000,
        "packageName": "7-Zip 23.01 x64",
        "packageSize": 1523712,
        "platform": "Windows"
      }
    ]
  }
                
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.