Retrieve Scan Details 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 detailed patch scan information for managed systems.

Endpoints

Request URL

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

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

branchOfficestringOptional

Branch office name filter

platformIdlongOptional

1: Windows, 2: Mac, 3: Linux

healthStatusIdlongOptional

0: Unknown, 1: Healthy, 2: Vulnerable, 3: Highly Vulnerable

liveStatusIdlongOptional

1: Agent Live, 2: Agent Down

installationStatuslongOptional

21: Not Installed (agent is not installed), 22: Installed (agent is installed)

cgIdlongOptional

Custom group ID filter

resourceIdlongOptional

Specific resource ID filter

scanStatuslongOptional

226: Failed, 227: In Progress, 228: Success, 229: Not Scanned

domainstringOptional

Domain name filter

customGroupFilterstringOptional

Get Custom Group list from api/1.4/desktop/serverproperties

kbnumberlongOptional

KB number filter

isWebViewstringOptional

Whether request is from web view

skipColumnsstringOptional

Comma-separated column names to exclude from response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/scanDetails \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Pagination metadata

Show Sub-Attributes
limitstring

Number of records per page

pagestring

Current page number

totalRecordsstring

Total number of records matching the query

messageResponseJSON Array

Array of scan detail entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
resource_name_transformstring

Transformed resource/computer name

agent_version_transformstring

Transformed agent version string

oslanguage_languageidstring

OS language ID

resource_health_statusstring

Resource health status code, or null

branch_office_idstring

Branch office ID

os_languagestring

OS language code

agent_installed_onstring

Agent installation time in epoch milliseconds

os_platform_namestring

OS platform name (Windows, Mac, Linux)

owner_transformstring

Transformed owner name, or --

service_packstring

OS service pack or version details

os_name_transformstring

Transformed OS name

os_language_abbrstring

OS language abbreviation (e.g., en, fr)

branchofficedetails_branch_office_idstring

Branch office details ID

domain_netbios_name_transformstring

Transformed domain NetBIOS name

os_platform_idstring

OS platform ID

os_platform_name_transformstring

Transformed OS platform name

pmreshealthstatus_resource_idstring

PM resource health status resource ID, or null

location_transformstring

Transformed location, or --

scan_remarksstring

Scan remarks i18n key

branch_office_name_transformstring

Transformed branch office name

i18n_transformstring

Transformed internationalization language name

agent_last_contact_time_transformstring

Formatted agent last contact time

os_platformstring

OS platform code

agent_last_ds_contact_timestring

Agent last distribution server contact time in epoch milliseconds

agent_logged_on_usersstring

Currently logged on users

osflavor_idstring

OS flavor ID

i18nstring

Internationalization language key

search_tagstring

Search tag, or --

status_labelstring

Installation status label key

error_kb_urlstring

Error KB article URL, or null

owner_email_idstring

Owner email address, or --

agent_installed_dir_transformstring

Transformed agent installation directory path

installation_statusstring

Installation status code

last_scan_time_transformstring

Formatted last scan time

friendly_name_transformstring

Transformed friendly name

scan_remarks_transformstring

Transformed scan remarks text

last_successful_scanstring

Last successful scan time in epoch milliseconds

branchmemberresourcerel_resource_idstring

Branch member resource relation ID

computer_status_update_timestring

Computer status update time in epoch milliseconds

branch_office_namestring

Branch office name

processor_architecturestring

Processor architecture code

agent_last_contact_timestring

Agent last contact time in epoch milliseconds

descriptionstring

Computer description, or null

owner_email_id_transformstring

Transformed owner email, or --

domain_netbios_namestring

Domain NetBIOS name

status_label_transformstring

Transformed installation status label

patch_status_labelstring

Patch scan status label key

ip_address_transformstring

Transformed IP address

search_tag_transformstring

Transformed search tag, or --

agent_installed_on_transformstring

Formatted agent installation date

agent_last_bootup_time_transformstring

Formatted agent last bootup time

agent_installed_dirstring

Agent installation directory path

mac_addressstring

MAC address(es), comma-separated

agent_last_ds_contact_time_transformstring

Formatted last DS contact time, or --

scan_remarks_argsstring

Scan remarks arguments, or null

patch_status_label_transformstring

Transformed patch scan status label

patchclientscanerror_resource_idstring

Patch client scan error resource ID, or null

ownerstring

Owner name, or --

patch_scan_error_codestring

Patch scan error code, or null

friendly_namestring

Friendly name of the resource

scan_statusstring

Scan status code

description_transformstring

Transformed description, or --

last_successful_scan_transformstring

Formatted last successful scan time

patch_status_imagestring

Patch status image path

last_sync_timestring

Last sync time in epoch milliseconds

agent_logged_on_users_transformstring

Transformed logged on users

ip_addressstring

IP address(es), comma-separated

service_pack_transformstring

Transformed service pack/OS version

patchmgmtosinfo_resource_idstring

Patch management OS info resource ID

agent_versionstring

Agent version string

mac_address_transformstring

Transformed MAC address

resource_health_status_transformstring

Transformed resource health status, or --

agent_last_bootup_timestring

Agent last bootup time in epoch milliseconds

resource_idstring

Unique resource identifier

os_namestring

Full OS name

locationstring

Location of the system, or --

computer_live_statusstring

Computer live status code

resource_namestring

Resource name

last_scan_timestring

Last scan time in epoch milliseconds

customer_idstring

Customer ID

totalPagesstring

Total number of pages available

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

statusstring

Operation result: success

- 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

Detailed scan report

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "1",
    "messageResponse": [
      {
        "resource_name_transform": "DESKTOP-3MGS2V0",
        "agent_version_transform": "11.5.2616.01.W",
        "oslanguage_languageid": "1",
        "resource_health_status": null,
        "branch_office_id": "1",
        "os_language": "1",
        "agent_installed_on": "1778777427871",
        "os_platform_name": "Windows",
        "owner_transform": "--",
        "service_pack": "Windows 11 Version 25H2 (x64)",
        "os_name_transform": "Windows 10 Education (x64)",
        "os_language_abbr": "en",
        "branchofficedetails_branch_office_id": "1",
        "domain_netbios_name_transform": "WORKGROUP",
        "os_platform_id": "1",
        "os_platform_name_transform": "Windows",
        "pmreshealthstatus_resource_id": null,
        "location_transform": "--",
        "scan_remarks": "dc.patch.util.Scanning_completedsuccessfully",
        "branch_office_name_transform": "Local Office",
        "i18n_transform": "French",
        "agent_last_contact_time_transform": "May 18, 2026 05:48 AM",
        "os_platform": "1",
        "agent_last_ds_contact_time": "0",
        "agent_logged_on_users": "pmp-test10",
        "osflavor_id": "0",
        "i18n": "dc.patch.patchinfo.English",
        "search_tag": "--",
        "status_label": "dc.db.som.status.installed_successfully",
        "error_kb_url": null,
        "owner_email_id": "--",
        "agent_installed_dir_transform": "C:\\Program Files (x86)\\ManageEngine\\UEMS_Agent\\",
        "installation_status": "22",
        "last_scan_time_transform": "May 17, 2026 08:56 PM",
        "friendly_name_transform": "DESKTOP-3MGS2V0",
        "scan_remarks_transform": "Scanning completed successfully",
        "last_successful_scan": "1779269204807",
        "branchmemberresourcerel_resource_id": "11",
        "computer_status_update_time": "1779101421159",
        "branch_office_name": "Local Office",
        "processor_architecture": "2",
        "agent_last_contact_time": "1779268735000",
        "description": null,
        "owner_email_id_transform": "--",
        "domain_netbios_name": "VMDRQA",
        "status_label_transform": "Installed Successfully",
        "patch_status_label": "dc.common.SCANNING_COMPLETED",
        "ip_address_transform": "192.168.130.129",
        "search_tag_transform": "--",
        "agent_installed_on_transform": "May 15, 2026 02:59 PM",
        "agent_last_bootup_time_transform": "May 16, 2026 01:04 AM",
        "agent_installed_dir": "C:\\Program Files (x86)\\ManageEngine\\UEMS_Agent\\",
        "mac_address": "0c:37:96:3c:69:48,00:15:5d:ae:26:77",
        "agent_last_ds_contact_time_transform": "--",
        "scan_remarks_args": null,
        "patch_status_label_transform": "Scanning Completed",
        "patchclientscanerror_resource_id": null,
        "owner": "--",
        "patch_scan_error_code": null,
        "friendly_name": "pmp-test10",
        "scan_status": "228",
        "description_transform": "--",
        "last_successful_scan_transform": "May 17, 2026 08:56 PM",
        "patch_status_image": "images/success.png",
        "last_sync_time": "1779273157893",
        "agent_logged_on_users_transform": "Administrateur",
        "ip_address": "10.72.70.236,172.19.64.1",
        "service_pack_transform": "Windows 10 Version 22H2 (x64)",
        "patchmgmtosinfo_resource_id": "11",
        "agent_version": "11.5.2616.01.W",
        "mac_address_transform": "00:0c:29:51:3e:f7",
        "resource_health_status_transform": "--",
        "agent_last_bootup_time": "1779042799000",
        "resource_id": "11",
        "os_name": "Windows 11 Professional Edition (x64)",
        "location": "--",
        "computer_live_status": "1",
        "resource_name": "pmp-test10",
        "last_scan_time": "1779269204807",
        "customer_id": "1"
      }
    ],
    "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.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.