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 Copied!

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

pageLimitintegerOptional

Number of records to be returned per page. Minimum 1, maximum 1000. Default is 25.

pageintegerOptional

Page number of the result set to be returned. Minimum 1, maximum 100000. Default is 1.

searchColumnstringOptional

Name of the column in which the search value needs to be looked up. Use together with searchValue.

searchValuestringOptional

Text to look up in the column given in searchColumn. Use together with searchColumn.

severitystringOptional

Returns only the patches of the given severity. Accepted values: 0 - Unrated, 1 - Low, 2 - Moderate, 3 - Important, 4 - Critical. Multiple values can be given as a comma-separated list.

bullteinIDstringOptional

Returns only the deployments of patches released under the given bulletins. A bulletin is the vendor advisory a patch is published under, for example MS15-041. Multiple Bulletin IDs can be given as a comma-separated list. Get the bulletin ID from Get Supported Patches.

deployedDatestringOptional

Returns only the patches deployed on the given date. Provide the date and time as epoch milliseconds. Multiple values can be given as a comma-separated list.

computerNamestringOptional

Returns only the systems whose name contains the given text.

domainstringOptional

Returns only the systems that belong to the given domain or workgroup. Provide the domain name as shown in Endpoint Central, for example, the NetBIOS name of the domain. Multiple values can be given as a comma-separated list. Get the domain names from Get Domains api

servicePackstringOptional

Returns only the systems that have the given service pack or OS build installed.

operatingSystemstringOptional

Returns only the systems running the given operating system. Provide the operating system name, for example, Windows 11. Multiple values can be given as a comma-separated list.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/SSPDetailedView \
  --header 'Accept: application/SSPDetailedView.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
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

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 401

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

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

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

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

- 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

Sample Response: HTTP 200

SSP detailed view

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

Sample Response: HTTP 401

Authentication credentials are missing, expired or invalid

Copied!
  {
    "error_code": "UAC_UNAUTHORIZED",
    "error_description": "dc.rest.authentication.unauthorized"
  }
                
▼ Show full

Sample Response: HTTP 403

Authenticated user lacks the required role or scope

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMessage": "You do not have sufficient privileges to perform this operation"
  }
                
▼ Show full

Sample Response: HTTP 429

API call threshold exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMessage": "API call limit exceeded. Retry after the lock period elapses"
  }
                
▼ Show full

Sample Response: HTTP 500

Server-side error

Copied!
  {
    "error_code": "INTERNAL_ERROR",
    "error_description": "dc.rest.api_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.