Fetch System Health Policy

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.

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Sample Request

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

Response Parameters

- HTTP code 200

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

System health policy data

Show Sub-Attributes
healthpolicyJSON Object

Health policy configuration

Show Sub-Attributes
advanced_settingsJSON Object

Advanced health policy settings

Show Sub-Attributes
consider_only_approvedboolean

When true, only approved patches are counted towards system health

excludePatchBasedOnstring

Mode used for the patch-age exclusion; the API returns the value 1

excludePatchForLaststring

Ignore patches released within the last N days when calculating health; 0 disables the exclusion (permitted range 0-365)

exclude_tp_appsboolean

When true, third-party application patches are excluded from the health calculation

ignoreBIOSApplicationsboolean

When true, BIOS and firmware patches are excluded from the health calculation

highly_vulnerableJSON Object

Missing-patch counts at or above which a system is classified as Highly Vulnerable

Show Sub-Attributes
criticalstring

Number of missing critical-severity patches required to reach this health state

importantstring

Number of missing important-severity patches required to reach this health state

lowstring

Number of missing low-severity patches required to reach this health state

moderatestring

Number of missing moderate-severity patches required to reach this health state

vulnerableJSON Object

Missing-patch counts at or above which a system is classified as Vulnerable

Show Sub-Attributes
criticalstring

Number of missing critical-severity patches required to reach this health state

importantstring

Number of missing important-severity patches required to reach this health state

lowstring

Number of missing low-severity patches required to reach this health state

moderatestring

Number of missing moderate-severity patches required to reach this health state

message_typestring

Value: healthpolicy

message_versionstring

API version: 1.4

statusstring

Operation status: success

- HTTP code 401

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

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

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

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

errorMsgstring

Rate limit exceeded message with retry guidance

Sample Response: HTTP 200

Copied!
  {
    "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"
  }
                
▼ Show full

Sample Response: HTTP 401

Authentication credentials are missing, expired or invalid

Copied!
  {
    "error_code": "UAC_UNAUTHORIZED",
    "error_description": "dc.rest.authentication.unauthorized"
  }
                
▼ Show full

Sample Response: HTTP 403

Authenticated user lacks the required role or scope

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMessage": "You do not have sufficient privileges to perform this operation"
  }
                
▼ Show full

Sample Response: HTTP 429

API call threshold exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMessage": "API call limit exceeded. Retry after the lock period elapses"
  }
                
▼ Show full