Retrieves the detailed Self Service Portal view with deployment status information.
get /dcapi/patch/reports/SSPDetailedView
https://{serverurl}/dcapi/patch/reports/SSPDetailedView Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Number of records to be returned per page. Minimum 1, maximum 1000. Default is 25.
Page number of the result set to be returned. Minimum 1, maximum 100000. Default is 1.
Name of the column in which the search value needs to be looked up. Use together with searchValue.
Text to look up in the column given in searchColumn. Use together with searchColumn.
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.
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.
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.
Returns only the systems whose name contains the given text.
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
Returns only the systems that have the given service pack or OS build installed.
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.
curl --request GET \
--url https://appdomains/dcapi/patch/reports/SSPDetailedView \
--header 'Accept: application/SSPDetailedView.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Pagination links for next and previous pages
URL for the next page of results, or null if on the last page
URL for the previous page of results, or null if on the first page
Array of SSP detailed view entries
Patch approval status: Approved, Not Approved
Security bulletin identifier
Name of the target computer
Date when the patch was deployed, or -- if not deployed
Current deployment status, or -- if not deployed
Domain name of the computer
Full operating system name and architecture
Full description of the patch
Unique patch identifier
Current patch status: Missing, Installed
Category of patch: Security Updates, Rollups, etc.
Additional remarks or -- if none
Service pack or OS version of the computer
Patch severity: Critical, Important, Moderate, Low
Pagination metadata
Operation result: success
Total number of pages available
Total number of records matching the query
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
Message indicating insufficient privileges to access this resource
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
Rate limit exceeded message with retry guidance
Error code: INTERNAL_ERROR for server-side failures
Localized error description: dc.rest.api_internal_error
SSP detailed view
{
"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
}
Authentication credentials are missing, expired or invalid
{
"error_code": "UAC_UNAUTHORIZED",
"error_description": "dc.rest.authentication.unauthorized"
}
Authenticated user lacks the required role or scope
{
"errorCode": "FORBIDDEN",
"errorMessage": "You do not have sufficient privileges to perform this operation"
}
API call threshold exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMessage": "API call limit exceeded. Retry after the lock period elapses"
}
Server-side error
{
"error_code": "INTERNAL_ERROR",
"error_description": "dc.rest.api_internal_error"
}
![]()
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.