Retrieve Self Service Portal Detailed View Report

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 detailed Self Service Portal view with deployment status information.

Request URL

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

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

severitystringOptional

0: Unrated, 1: Low, 2: Moderate, 3: Important, 4: Critical (comma-separated)

bullteinIDstringOptional

Bulletin ID filter (comma-separated)

deployedDatestringOptional

Deployment date filter (comma-separated)

computerNamestringOptional

Computer name filter

domainstringOptional

Domain name filter

servicePackstringOptional

Service pack filter

operatingSystemstringOptional

Operating system name filter

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/SSPDetailedView \
  --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 detailed view entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
ApproveStatusstring

Patch approval status: Approved, Not Approved

BulletinIdstring

Security bulletin identifier

ComputerNamestring

Name of the target computer

DeployedDatestring

Date when the patch was deployed, or -- if not deployed

DeploymentStatusstring

Current deployment status, or -- if not deployed

Domainstring

Domain name of the computer

OperatingSystemstring

Full operating system name and architecture

PatchDescriptionstring

Full description of the patch

PatchIdstring

Unique patch identifier

PatchStatusstring

Current patch status: Missing, Installed

PatchTypestring

Category of patch: Security Updates, Rollups, etc.

Remarksstring

Additional remarks or -- if none

ServicePackstring

Service pack or OS version of the computer

Severitystring

Patch severity: Critical, Important, Moderate, Low, Unrated

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 detailed view

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 2,
    "messageResponse": [
      {
        "OperatingSystem": "Windows 11 Professional Edition (x64)",
        "ApproveStatus": "Approved",
        "BulletinId": "MS24-DEC3",
        "PatchStatus": "Missing",
        "PatchId": "40280",
        "Severity": "Critical",
        "DeployedDate": "--",
        "Remarks": "--",
        "ComputerName": "WinMachine1",
        "ServicePack": "Windows 11 Version 23H2 (x64)",
        "PatchDescription": "2024-12 Cumulative Update for Windows 11 Version 23H2 for x64-based Systems (KB5048685) (CVE-2024-49138)",
        "PatchType": "Security Updates",
        "Domain": "ZOHOCORP",
        "DeploymentStatus": "--"
      },
      {
        "OperatingSystem": "Windows 11 Professional Edition (x64)",
        "ApproveStatus": "Approved",
        "BulletinId": "MS22-JAN14",
        "PatchStatus": "Missing",
        "PatchId": "32830",
        "Severity": "Important",
        "DeployedDate": "--",
        "Remarks": "--",
        "ComputerName": "WinMachine1",
        "ServicePack": "Windows 11 Version 23H2 (x64)",
        "PatchDescription": "KB5009719, 2022-01 Security and Quality Rollup for .NET Framework 4.5.2 for Windows 7 for x64 (KB5008860) (ESU)",
        "PatchType": "Rollups",
        "Domain": "ZOHOCORP",
        "DeploymentStatus": "--"
      }
    ],
    "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.