Retrieves systems that are mapped to Automated Patch Deployment (APD) tasks.
get /dcapi/patch/reports/apdMappedSystems
https://{serverurl}/dcapi/patch/reports/apdMappedSystems 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 systems or patches belonging to the given operating system platform. Accepted values: 1 - Windows, 2 - Mac, 3 - Linux. Multiple values can be given as a comma-separated list.
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 belong to the given remote office (branch office). Provide the remote office name as configured in Endpoint Central. Multiple values can be given as a comma-separated list. Get the remote office names from Get Remote Offices api
Returns only the systems that are members of the given custom group. Provide the custom group name as configured in Endpoint Central. Multiple values can be given as a comma-separated list. Get the custom group names from Get Custom Groups 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.
Returns only the systems that have the given IP address.
Returns only the entries belonging to the APD task whose name contains the given text. Get the task names from Get APD Tasks api
Returns only the entries that use the deployment policy with the given name. Get the policy names from Get Deployment Policies api
curl --request GET \
--url https://appdomains/dcapi/patch/reports/apdMappedSystems \
--header 'Accept: application/ApdMappedSystems.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Array of report-specific data records
Total number of records
Current page number
Records per page
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 mapped systems
{
"data": [
{
"computerName": "WS-PC-001",
"domainName": "CORP",
"platform": "Windows",
"operatingSystem": "Windows 11 Pro",
"taskName": "Monthly Patching",
"deploymentPolicyName": "Default Policy"
}
],
"total": 95,
"page": 1,
"pageLimit": 25
}
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.