Retrieve Deployment Tasks Published to Self Service Portal

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

Retrieves the list of patch deployment tasks published to the Self Service Portal.

Request URL

https://{serverurl}/dcapi/patch/reports/SSPDeploymentList

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pageLimitintegerOptional

Number of records per page (default 25)

pageintegerOptional

Page number to retrieve (1-based)

searchColumnstringOptional

Column name to search within

searchValuestringOptional

Value to search for in the specified column

taskTypestringOptional

0: All Tasks, 1: Manual Deployment, 2: APD (comma-separated)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/SSPDeploymentList \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Pagination links for next and previous pages

Show Sub-Attributes
nextstring

URL for the next page of results, or null if on the last page

prevstring

URL for the previous page of results, or null if on the first page

messageResponseJSON Array

Array of SSP deployment task entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
PublishedSystemsstring

Number of systems where the task has been published

TaskNamestring

Name of the deployment task

TotalTargetsstring

Total number of target systems for the task

YetToPublishstring

Number of systems yet to be published

metadataJSON Object

Pagination metadata

Show Sub-Attributes
limitstring

Number of records per page

pagestring

Current page number

statusstring

Operation result: success

totalPagesstring

Total number of pages available

totalRecordsstring

Total number of records matching the query

- HTTP code 500

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

Error code: INTERNAL_ERROR for server-side failures

error_descriptionstring

Localized error description: dc.rest.api_internal_error

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

SSP deployment list

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 4,
    "messageResponse": [
      {
        "YetToPublish": "9",
        "TaskName": "MyConfiguration3",
        "TotalTargets": "9",
        "PublishedSystems": "0"
      },
      {
        "YetToPublish": "3",
        "TaskName": "MyTask1",
        "TotalTargets": "3",
        "PublishedSystems": "0"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }
                
Show full

Sample Response: HTTP 500

Server-side error

Copied!
  {
    "error_description": "dc.rest.api_internal_error",
    "error_code": "INTERNAL_ERROR"
  }
                
Show full

Duration: 1 minute | Threshold: 50 | 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.