Retrieves the systems view for a specific Automated Patch Deployment (APD) task.
get /dcapi/patch/reports/apdSystemsView
https://{serverurl}/dcapi/patch/reports/apdSystemsView 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.
Unique identifier of the Automated Patch Deployment (APD) task whose mapped systems need to be retrieved. Get the value from Get APD Tasks
curl --request GET \
--url 'https://appdomains/dcapi/patch/reports/apdSystemsView?taskId=SOME_INTEGER_VALUE' \
--header 'Accept: application/apdSystemsView.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 APD task systems view entries
Date and time the agent was installed on the system
File system path where the agent is installed
Version of the agent installed on the system
Name of the computer
Status of the APD task deployment on this system, e.g., Patches Missing
Friendly/display name of the device
Domain name of the computer
Number of patches that failed to install, or --
Number of installed patches, or --
Operating system language
Last time the agent contacted the server
Last contacted time with distribution server, or --
Last time a deployment was executed on this system, or --
Last successful scan time
Currently logged on users
Number of missing patches, or --
Full operating system name and architecture
Additional remarks, or --
Remote office name
Service pack or OS version
Last updated timestamp, or --
Wake-on-LAN remarks, or --
Wake-on-LAN status, or --
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
APD task systems view
{
"metadata": {
"limit": 25,
"page": 1
},
"totalRecords": 1,
"messageResponse": [
{
"OperatingSystem": "Windows 11 Professional Edition (x64)",
"AgentVersion": "11.5.2627.37.W",
"DeviceFriendlyName": "WIN-SYSTEM-01",
"LastSuccessfulScan": "Sep 7, 2026 11:02 PM",
"UpdatedAt": "--",
"LastContactedTimeWithDs": "--",
"RemoteOffice": "Default Remote Office",
"LoggedOnUsers": "user01",
"WolStatus": "--",
"FailedPatches": "0",
"Language": "English",
"Remarks": "--",
"LastContactTime": "Aug 27, 2026 07:07 PM",
"MissingPatches": "0",
"AgentInstalledDate": "Aug 27, 2026 07:07 PM",
"ServicePack": "Windows 11 Version 23H2 (x64)",
"ComputerName": "WIN-SYSTEM-01",
"WolRemarks": "--",
"InstalledPatches": "0",
"LastDeploymentTime": "--",
"Domain": "WORKGROUP",
"AgentInstalledDirectory": "C:\\Program Files (x86)\\DesktopCentral_Agent\\",
"DeploymentStatus": "Patches Missing"
}
],
"totalPages": 1,
"Links": {
"next": null,
"prev": null
},
"status": "success"
}
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.