Retrieve Patch Scan System List Deprecating soon

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 the list of all systems along with their patch scan status.

This API endpoint is deprecating soon

Endpoints

Request URL

https://{serverurl}/api/1.4/patch/scandetails

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

residstringOptional

Filter for system with a resource id

domainfilterstringOptional

Get domain list from api/1.4/desktop/serverproperties

platformfilterstringOptional

Windows/Mac/Linux

branchofficefilterstringOptional

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

customgroupfilterstringOptional

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

healthfilterintegerOptional

0: Unknown — patch status is not available, 1: Healthy — system is up-to-date, 2: Vulnerable — system has missing patches, 3: Highly Vulnerable — system has critical or high-risk missing patches

livestatusfilterintegerOptional

1: Agent Live (agent is running), 2: Agent Down (agent is not responding)

searchvaluestringOptional
searchcolumnstringOptional
searchtypestringOptional
sortorderstringOptional
orderbystringOptional
pagelimitstringOptional

Number of records per page.

pageintegerOptional

Current page number for pagination.

customeridlongOptional
agentinstallationstatusfilterintegerOptional

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

scanstatusfilterintegerOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/1.4/patch/scandetails \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object
Hide Sub-Attributes
message_typestring

Value: scandetails

message_responseJSON object

Paginated scan details data

Show Sub-Attributes
totalstring

Total number of systems with scan data

scandetailsJSON array

Array of system scan detail objects

Show Sub-Attributes
JSON object
Show Sub-Attributes
resource.namestring

Computer name of the system

resource_idlong

Unique resource identifier

resource.domain_netbios_namestring

Domain name of the system

branch_office_namestring

Branch or remote office name

branch_office_idstring

Branch office identifier

scan_statusstring

Scan status: 226=Failed, 227=InProgress, 228=Success, 229=NotScanned

computer_live_statusstring

Live status: 1=Live, 2=Down

resource_health_statusstring

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

installation_statusstring

Installation status code

os_platformstring

Platform ID: 1=Windows, 2=Mac, 3=Linux

os_platform_namestring

Platform name

os_namestring

Full operating system name

service_packstring

Service pack or OS version

agent_versionstring

Agent version installed

last_scan_timelong

Timestamp of last scan attempt

last_successful_scanlong

Timestamp of last successful scan

ip_addressstring

IP address(es) of the system

mac_addressstring

MAC address(es) of the system

scan_remarksstring

Scan result remarks

limitstring

Records per page

pagestring

Current page number

message_versionstring

API version: 1.0

statusstring

Operation status: success

response_codestring

Response code: 200

Possible HTTP Status Codes

200HTTP code

Sample Response: HTTP 200

Paginated list of systems with scan status

Copied!
  {
    "response_code": 200,
    "message_type": "scandetails",
    "message_response": {
      "total": 94,
      "limit": 25,
      "page": 1,
      "scandetails": [
        {
          "branch_office_name": "Local Office",
          "scan_status": 228,
          "resource.name": "WIN-SERVER-01",
          "resource_health_status": 3,
          "scan_remarks": "dc.patch.util.Scanning_completedsuccessfully",
          "os_platform": 1,
          "ip_address": "192.168.1.100",
          "branch_office_id": 1,
          "os_platform_name": "Windows",
          "agent_version": "10.0.267.W",
          "mac_address": "00:0c:29:7e:51:a7",
          "resource.domain_netbios_name": "WORKGROUP",
          "service_pack": "Windows 10 Version 1803 (x64)",
          "resource_id": 47707,
          "installation_status": 22,
          "os_name": "Windows 10 Professional Edition (x64)",
          "computer_live_status": 1,
          "last_scan_time": 1552904526258,
          "last_successful_scan": 1552904526258
        }
      ]
    },
    "message_version": "1.0",
    "status": "success"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | 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.