Fetch System Health Policy 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 currently configured system health policy in Endpoint Central.

This API endpoint is deprecating soon

Endpoints

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

searchvaluestringOptional
searchcolumnstringOptional
searchtypestringOptional
sortorderstringOptional
orderbystringOptional
pagelimitstringOptional

Number of records per page.

pageintegerOptional

Current page number for pagination.

customeridlongOptional

Sample Request

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

Response Parameters

- HTTP code 200

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

Value: healthpolicy

message_responseJSON Object

System health policy data

Show Sub-Attributes
healthpolicyJSON Object

Health policy configuration

Show Sub-Attributes
vulnerableJSON Object

Thresholds for vulnerable status

Show Sub-Attributes
criticalstring

Threshold count for critical severity patches

importantstring

Threshold count for important severity patches

moderatestring

Threshold count for moderate severity patches

lowstring

Threshold count for low severity patches

highly_vulnerableJSON Object

Thresholds for highly vulnerable status

Show Sub-Attributes
criticalstring

Threshold count for critical severity patches

importantstring

Threshold count for important severity patches

moderatestring

Threshold count for moderate severity patches

lowstring

Threshold count for low severity patches

advanced_settingsJSON Object

Advanced health policy settings

Show Sub-Attributes
exclude_tp_appsboolean

Whether to exclude third-party applications from

consider_only_approvedboolean

Whether to consider only approved patches in health

message_versionstring

API version: 1.0

statusstring

Operation status: success

response_codestring

Response code: 200

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Current system health policy with vulnerability thresholds

Copied!
  {
    "response_code": 200,
    "message_type": "healthpolicy",
    "message_response": {
      "healthpolicy": {
        "vulnerable": {
          "important": 49,
          "critical": 0,
          "low": 99,
          "moderate": 74
        },
        "highly_vulnerable": {
          "important": 50,
          "critical": 1,
          "low": 100,
          "moderate": 75
        },
        "advanced_settings": {
          "exclude_tp_apps": false,
          "consider_only_approved": false
        }
      }
    },
    "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.