# Retrieve System Health Report

Retrieves the system health report based on patch management metrics.

## Endpoints

`GET /dcapi/patch/reports/systemHealth`

## Request URL

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

### Scope

`PatchMgmt.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Sample Request

```curl
curl --request GET \
  --url https://appdomain/dcapi/patch/reports/systemHealth \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP code 200

#### Response Body — application/json

JSON object:

- **Links** — JSON object  
  Pagination links for next and previous pages
- **messageResponse** — JSON array  
  Array of system health entries
- **metadata** — JSON object  
  Pagination metadata
- **status** — string  
  Operation result: success
- **totalPages** — string  
  Total number of pages available
- **totalRecords** — string  
  Total number of records matching the query

### HTTP code 500

#### Response Body — application/json

JSON object:

- **error_code** — string  
  Error code: INTERNAL_ERROR for server-side failures
- **error_description** — string  
  Localized error description: dc.rest.api_internal_error

## Possible Response Codes

- **200** — HTTP code
- **500** — HTTP code

## Sample Response: HTTP 200

System health report

```json
{
  "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"
}
```

## Sample Response: HTTP 500

Server-side error

```json
{
  "error_description": "dc.rest.api_internal_error",
  "error_code": "INTERNAL_ERROR"
}
```

## Rate Limit

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.