Retrieve System Health 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 the system health report based on patch management metrics.

Endpoints

Request URL

https://{server-hostname}:8383/dcapi/patch/reports/systemHealth

Scope

PatchMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/patch/reports/systemHealth \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
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

messageResponseJSON array

Array of system health entries

Show Sub-Attributes
JSON object
Show Sub-Attributes
ComputerNamestring

Name of the computer

Criticalstring

Number of critical missing patches

DeviceFriendlyNamestring

Friendly display name of the device

Domainstring

Domain name of the computer

Healthstring

Health status: Healthy, Vulnerable, Highly Vulnerable

Importantstring

Number of important missing patches

InstalledBiosPatchesstring

Count of installed BIOS patches

InstalledDriverPatchesstring

Count of installed driver patches

InstalledOsPatchesstring

Count of installed OS patches

InstalledTpPatchesstring

Count of installed third-party patches

IpAddressstring

IP address of the system

Languagestring

Language of the operating system

LastBootTimestring

Last boot time of the system

LastContactTimestring

Last time the agent contacted the server

LastContactedTimeWithDsstring

Last contacted time with distribution server, or --

LastPatchedTimestring

Last time a patch was applied, or --

LastScanstring

Last scan time

LastSuccessfulScanstring

Last successful scan time

Locationstring

Location of the system, or --

LoggedOnUsersstring

Currently logged on users

Lowstring

Number of low-severity missing patches

MacAddressstring

MAC address of the system

MissingBiosPatchesstring

Count of missing BIOS patches

MissingDriverPatchesstring

Count of missing driver patches

MissingOsPatchesstring

Count of missing OS patches

MissingTpPatchesstring

Count of missing third-party patches

Moderatestring

Number of moderate-severity missing patches

Notesstring

Admin notes, or --

OperatingSystemstring

Full operating system name

OsPlatformstring

Platform: Windows, Mac, Linux

Ownerstring

Owner of the system, or --

OwnerEmailstring

Email of the system owner, or --

Remarksstring

Deployment remarks, or --

RemoteOfficestring

Remote office name

SearchTagstring

Search tag, or --

ServicePackstring

Service pack or OS version

Shutdown/restartRemarksstring

Shutdown or restart remarks, or --

TimeZonestring

Timezone of the system

TotalBiosPatchesstring

Total BIOS patches count

TotalDriverPatchesstring

Total driver patches count

TotalOsPatchesstring

Total OS patches count

TotalPatchesstring

Total patches count

TotalTpPatchesstring

Total third-party patches count

metadataJSON object

Pagination metadata

Show Sub-Attributes
limitstring

Number of records per page

pagestring

Current page number

statusstring

Operation result: success

totalPagesstring

Total number of pages available

totalRecordsstring

Total number of records matching the query

- 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

System health report

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 2,
    "messageResponse": [
      {
        "OperatingSystem": "Windows 7 Professional Edition (x64)",
        "Owner": "--",
        "TotalPatches": "11",
        "Important": "0",
        "Critical": "0",
        "LastPatchedTime": "--",
        "LastContactedTimeWithDs": "--",
        "RemoteOffice": "Default Remote Office",
        "TotalBiosPatches": "0",
        "LastBootTime": "Dec 14, 2015 10:44 AM",
        "LastScan": "Mar 3, 2025 06:21 PM",
        "Language": "Multilingual",
        "Moderate": "0",
        "MissingOsPatches": "0",
        "Remarks": "--",
        "LastContactTime": "Mar 3, 2025 06:20 PM",
        "MissingDriverPatches": "0",
        "InstalledTpPatches": "9",
        "TotalDriverPatches": "0",
        "InstalledBiosPatches": "0",
        "SearchTag": "--",
        "Notes": "--",
        "OwnerEmail": "--",
        "DeviceFriendlyName": "WinMachine4",
        "Health": "Healthy",
        "InstalledDriverPatches": "0",
        "OsPlatform": "Windows",
        "TotalOsPatches": "2",
        "LastSuccessfulScan": "Mar 3, 2025 06:21 PM",
        "MacAddress": "d5:63:b0:a2:62",
        "TotalTpPatches": "9",
        "LoggedOnUsers": "Browser Security Manager",
        "MissingBiosPatches": "0",
        "TimeZone": "GMT-8:0",
        "Low": "0",
        "ComputerName": "WinMachine4",
        "ServicePack": "Windows 7 SP1 (x64)",
        "IpAddress": "252.148.93.191",
        "Domain": "ZOHOCORP",
        "InstalledOsPatches": "2",
        "Shutdown/restartRemarks": "--",
        "Location": "--",
        "MissingTpPatches": "0"
      },
      {
        "OperatingSystem": "Mac OS X - Mojave",
        "Owner": "--",
        "TotalPatches": "12",
        "Important": "3",
        "Critical": "1",
        "LastPatchedTime": "--",
        "LastContactedTimeWithDs": "--",
        "RemoteOffice": "Default Remote Office",
        "TotalBiosPatches": "0",
        "LastBootTime": "Dec 14, 2015 10:44 AM",
        "LastScan": "Mar 3, 2025 06:21 PM",
        "Language": "Multilingual",
        "Moderate": "0",
        "MissingOsPatches": "0",
        "Remarks": "--",
        "LastContactTime": "Mar 3, 2025 06:20 PM",
        "MissingDriverPatches": "0",
        "InstalledTpPatches": "5",
        "TotalDriverPatches": "0",
        "InstalledBiosPatches": "0",
        "SearchTag": "--",
        "Notes": "--",
        "OwnerEmail": "--",
        "DeviceFriendlyName": "MacMachine1",
        "Health": "Highly Vulnerable",
        "InstalledDriverPatches": "0",
        "OsPlatform": "Mac",
        "TotalOsPatches": "0",
        "LastSuccessfulScan": "Mar 3, 2025 06:21 PM",
        "MacAddress": "d5:07:b3:a0:26",
        "TotalTpPatches": "12",
        "LoggedOnUsers": "Administrator",
        "MissingBiosPatches": "0",
        "TimeZone": "GMT-8:0",
        "Low": "0",
        "ComputerName": "MacMachine1",
        "ServicePack": "Mac OS X - Mojave 10.14.1",
        "IpAddress": "207.157.88.219",
        "Domain": "ZOHOCORP",
        "InstalledOsPatches": "0",
        "Shutdown/restartRemarks": "--",
        "Location": "--",
        "MissingTpPatches": "7"
      }
    ],
    "totalPages": 2,
    "Links": {
      "next": "/dcapi/patch/reports/systemHealth?page=2&pageLimit=25",
      "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.

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