Retrieves the currently configured system health policy in Endpoint Central.
get /api/1.4/patch/healthpolicy
https://{serverurl}/api/1.4/patch/healthpolicy Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
curl --request GET \
--url https://appdomains/api/1.4/patch/healthpolicy \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'System health policy data
Health policy configuration
Advanced health policy settings
When true, only approved patches are counted towards system health
Mode used for the patch-age exclusion; the API returns the value 1
Ignore patches released within the last N days when calculating health; 0 disables the exclusion (permitted range 0-365)
When true, third-party application patches are excluded from the health calculation
When true, BIOS and firmware patches are excluded from the health calculation
Missing-patch counts at or above which a system is classified as Highly Vulnerable
Number of missing critical-severity patches required to reach this health state
Number of missing important-severity patches required to reach this health state
Number of missing low-severity patches required to reach this health state
Number of missing moderate-severity patches required to reach this health state
Missing-patch counts at or above which a system is classified as Vulnerable
Number of missing critical-severity patches required to reach this health state
Number of missing important-severity patches required to reach this health state
Number of missing low-severity patches required to reach this health state
Number of missing moderate-severity patches required to reach this health state
Value: healthpolicy
API version: 1.4
Operation status: success
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
Message indicating insufficient privileges to access this resource
Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
Rate limit exceeded message with retry guidance
{
"message_response": {
"healthpolicy": {
"advanced_settings": {
"consider_only_approved": false,
"excludePatchBasedOn": 1,
"excludePatchForLast": 0,
"exclude_tp_apps": false,
"ignoreBIOSApplications": false
},
"highly_vulnerable": {
"critical": 1,
"important": 1,
"low": 0,
"moderate": 0
},
"vulnerable": {
"critical": 0,
"important": 0,
"low": 1,
"moderate": 1
}
}
},
"message_type": "healthpolicy",
"message_version": "1.4",
"status": "success"
}
Authentication credentials are missing, expired or invalid
{
"error_code": "UAC_UNAUTHORIZED",
"error_description": "dc.rest.authentication.unauthorized"
}
Authenticated user lacks the required role or scope
{
"errorCode": "FORBIDDEN",
"errorMessage": "You do not have sufficient privileges to perform this operation"
}
API call threshold exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMessage": "API call limit exceeded. Retry after the lock period elapses"
}
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.