Scan Systems


This API lists all the systems and their patch scan status.

  • Functionality
  • Retrieve the patch scan system list.
  • HTTP Method 
  • GET
  • API URI
  • api/1.4/patch/scandetails
  • Scope
  • PatchManagerPlusCloud.PatchMgmt.READ
  • Filters
  • domainfilter={String}:

    Get domain list from api/1.4/desktop/serverproperties

    branchofficefilter={String}:

    Get branch office list from api/1.4/desktop/serverproperties

    customgroupfilter={String}:

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

    platformfilter={String}:

    Windows/Mac

    resid={Numeric}:

    Filter for system with a resource id

    healthfilter={Numeric}:

    0 - Unknown
    1 - Healthy
    2 - Vulnerable
    3 - Highly Vulnerable

    livestatusfilter={Numeric}

    1 - Agent Live
    2 - Agent Down

    agentinstallationstatusfilter={Numeric}

    21 - Not Installed
    22 - Installed
  • Response Parameters
  • computer_live_status:

    1 - Live
    2 - Down

    os_platform:

    1 - Windows
    2 - Mac

    installation_status:

    21 - Agent Not Installed
    22 - Agent Installed

    scan_status:

    226 - Failed
    227 - In Progress
    228 - Success
    229 - Not Scanned

    resource_health_status:

    0 - Unknown
    1 - Healthy
    2 - Vulnerable
    3 - Highly Vulnerable

Response Data

 { 	"message_type": "scandetails", 	"message_response": { 		"total": 94, 		"limit": 25, 		"page": 1, 		"scandetails": [ 			{ 				"branch_office_name": "Local Office", 				"resource.name": "XXXX-YY-ZZ-1", 				"resource_health_status": 3, 				"description": "--", 				"branch_office_id": 1, 				"os_language": 1, 				"agent_installed_on": 1548677081796, 				"os_platform_name": "Windows", 				"pmreshealthstatus.resource_id": 47707, 				"patchstatusdefn.label": "dc.common.SCANNING_COMPLETED", 				"branchofficedetails.branch_office_id": 1, 				"agent_installed_dir": "C:\\Program Files (x86)\\DesktopCentral_Agent\\", 				"mac_address": "00:0c:29:7e:51:a7,46:15:cf:8f:af:8f,00:15:5d:79:ec:dd,", 				"resource.domain_netbios_name": "WORKGROUP", 				"service_pack": "Windows 10 Version 1803 (x64)", 				"os_language_abbr": "en", 				"resource.resource_id": 47707, 				"scan_remarks_args": "--", 				"os_platform_id": 1, 				"owner": "--", 				"configstatusdefn.label": "dc.db.som.status.installed_successfully", 				"scan_status": 228, 				"scan_remarks": "dc.patch.util.Scanning_completedsuccessfully", 				"agentcontact.logged_on_users": "Administrator", 				"os_platform": 1, 				"oslanguage.languageid": 1, 				"last_sync_time": 1552904282877, 				"oslanguage.i18n": "dc.patch.patchinfo.English", 				"ip_address": "XXX.XX.YYY.YYY,XXX.YY.XX.YY,XXX.YY.YY.X,", 				"osflavor_id": 0, 				"search_tag": "--", 				"agent_version": "10.0.267.W", 				"owner_email_id": "--", 				"patchstatusdefn.image_name": "/images/success.png", 				"installation_status": 22, 				"resource_id": 47707, 				"os_name": "Windows 10 Professional Edition (x64)", 				"agentcontact.last_contact_time": 1552956951000, 				"location": "--", 				"computer_live_status": 1, 				"agentcontact.last_bootup_time": 1552629463000, 				"last_scan_time": 1552904526258, 				"patchmgmtosinfo.resource_id": 47707, 				"errorcodetokburl.kb_url": "--", 				"last_successful_scan": 1552904526258, 				"computer_status_update_time": 1552903541615 			}, ] 	}, 	"message_version": "1.0", 	"status": "success", 	"response_code": 200 }