Retrieve Patch Details Summary Deprecating soon

Provides various summaries related to the patch module including health status, scan summary, and other key metrics.

This API endpoint is deprecating soon

Endpoints

get /api/1.4/patch/summary

Copy full URL

Request URL

https://{server-hostname}:8383/api/1.4/patch/summary

Scope

PatchMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/api/1.4/patch/summary \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/1.4/patch/summary"))
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = { 'Authorization': " d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/api/1.4/patch/summary", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomain/api/1.4/patch/summary"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/1.4/patch/summary' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

message_typestring

Value: summary

message_responseJSON Object

Patch module summary data

Show Sub-Attributes

summaryJSON Object

Top-level summary object containing all sub-summaries

Show Sub-Attributes

patch_summaryJSON Object

Patch-level summary with counts

Show Sub-Attributes

installed_patchesstring

Total installed patches across all systems

applicable_patchesstring

Total applicable patches

new_patchesstring

Newly released patches

missing_patchesstring

Total missing patches

missing_patch_severity_summaryJSON Object

Missing patches grouped by severity

Show Sub-Attributes

critical_countstring

Missing patches with Critical severity

important_countstring

Missing patches with Important severity

moderate_countstring

Missing patches with Moderate severity

low_countstring

Missing patches with Low severity

unrated_countstring

Missing patches with no severity rating

total_countstring

Total missing patches across all severities

system_summaryJSON Object

System health summary

Show Sub-Attributes

total_systemsstring

Total managed systems

healthy_systemsstring

Systems with healthy patch status

moderately_vulnerable_systemsstring

Systems with moderate vulnerability

highly_vulnerable_systemsstring

Systems with high vulnerability

health_unknown_systemsstring

Systems with unknown health status

patch_scan_summaryJSON Object

Scan status summary

Show Sub-Attributes

scanned_systemsstring

Total systems that have been scanned

unscanned_system_countstring

Systems never scanned

scan_success_countstring

Systems with successful last scan

scan_failure_countstring

Systems with failed last scan

vulnerability_db_summaryJSON Object

Vulnerability database update status

Show Sub-Attributes

last_db_update_timelong

Timestamp of last vulnerability DB update

last_db_update_statusstring

Status of last DB update: Success or Failed

next_db_update_scheduled_timelong

Timestamp of next scheduled DB update

is_auto_db_update_disabledboolean

Whether automatic DB updates are disabled

db_update_in_progressstring

Whether a DB update is currently in progress: true or false

apd_summaryJSON Object

APD tasks summary

Show Sub-Attributes

number_of_apd_tasksstring

Total number of APD tasks configured

last_task_scheduled_timestring

Timestamp of last scheduled APD task, null if none

next_task_scheduled_timestring

Timestamp of next scheduled APD task, null if none

last_executed_taskstring

Name of last executed APD task, null if none

next_taskstring

Name of next APD task to execute, null if none

message_versionstring

API version: 1.0

statusstring

Operation status: success

response_codestring

Response code: 200

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Complete patch module summary

Copied!

  {
    "response_code": 200,
    "message_type": "summary",
    "message_response": {
      "summary": {
        "patch_summary": {
          "installed_patches": 2307,
          "applicable_patches": 3921,
          "new_patches": 369,
          "missing_patches": 1614
        },
        "missing_patch_severity_summary": {
          "moderate_count": 68,
          "unrated_count": 589,
          "total_count": 1614,
          "critical_count": 293,
          "important_count": 568,
          "low_count": 96
        },
        "apd_summary": {
          "last_task_scheduled_time": null,
          "next_task_scheduled_time": null,
          "number_of_apd_tasks": 33,
          "last_executed_task": null,
          "next_task": null
        },
        "system_summary": {
          "total_systems": 97,
          "moderately_vulnerable_systems": 0,
          "healthy_systems": 35,
          "highly_vulnerable_systems": 61,
          "health_unknown_systems": 1
        },
        "patch_scan_summary": {
          "unscanned_system_count": 2,
          "scanned_systems": 95,
          "scan_success_count": 37,
          "scan_failure_count": 58
        },
        "vulnerability_db_summary": {
          "last_db_update_status": "Success",
          "next_db_update_scheduled_time": 1553058600000,
          "is_auto_db_update_disabled": false,
          "last_db_update_time": 0,
          "db_update_in_progress": "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.