Retrieve Patch Scan Status Report Deprecating soon

Retrieves the patch scan status report for all managed systems.

This API endpoint is deprecating soon

Endpoints

get /dcapi/patch/reports/scan

Copy full URL

Request URL

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

Scope

PatchMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/dcapi/patch/reports/scan \
  --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/dcapi/patch/reports/scan"))
        .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", "/dcapi/patch/reports/scan", 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/dcapi/patch/reports/scan"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

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

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

LinksJSON Object

Pagination links for next and previous pages

Show Sub-Attributes

nextstring

URL for the next page of results, or null if on the last page

prevstring

URL for the previous page of results, or null if on the first page

messageResponseJSON Array

Array of scan status report entries

Show Sub-Attributes

JSON Object

Show Sub-Attributes

AgentInstalledDatestring

Date and time when the agent was installed

AgentInstalledDirectorystring

Directory path where the agent is installed

AgentStatusstring

Current agent installation status

AgentVersionstring

Version of the installed agent

ComputerNamestring

Name of the computer

DeviceFriendlyNamestring

User-friendly display name of the device

Domainstring

Domain or workgroup the computer belongs to

Healthstring

System health status: Healthy, Vulnerable, Highly Vulnerable

IpAddressstring

IP address of the system

Languagestring

Language of the operating system

LastBootTimestring

Last boot/restart time of the system

LastContactTimestring

Last time the agent contacted the server

LastContactedTimeWithDsstring

Last time the agent contacted the distribution server, or -- if not applicable

LastScanstring

Date and time of the last patch scan

LastScanStatusstring

Status of the last scan: Scanning Completed, Scanning In Progress, Scan Failed, Not Scanned

LastSuccessfulScanstring

Date and time of the last successful patch scan

Locationstring

Physical location of the system, or -- if not set

LoggedOnUsersstring

Currently or last logged-on user(s)

MacAddressstring

MAC address of the system

Notesstring

Admin notes for this system, or -- if none

OperatingSystemstring

Full operating system name and architecture

OsPlatformstring

OS platform: Windows, Mac, Linux

Ownerstring

Assigned owner of the device, or -- if not set

OwnerEmailstring

Email of the device owner, or -- if not set

Remarksstring

Additional scan remarks or error details

RemoteOfficestring

Remote office the system belongs to

SearchTagstring

Search tag assigned to the system, or -- if none

ServicePackstring

Service pack level, or -- if not applicable

metadataJSON Object

Pagination metadata

Show Sub-Attributes

limitstring

Number of records per page

pagestring

Current page number

statusstring

Operation result: success

totalPagesstring

Total number of pages available

totalRecordsstring

Total number of records matching the query

- HTTP code 500

Response Body - application/json

JSON Object

Hide Sub-Attributes

error_codestring

Error code: INTERNAL_ERROR for server-side failures

error_descriptionstring

Localized error description: dc.rest.api_internal_error

Possible Response Codes

200HTTP code

500HTTP code

Sample Response: HTTP 200

Scan status report data

Copied!

  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 1,
    "messageResponse": [
      {
        "OperatingSystem": "Red Hat Enterprise Linux 8 (x86_64)",
        "LastScanStatus": "Scanning Completed",
        "Owner": "--",
        "AgentVersion": "10.0.337.L",
        "LastContactedTimeWithDs": "--",
        "RemoteOffice": "localOfficeOne",
        "LastBootTime": "Dec 14, 2015 10:44 AM",
        "LastScan": "Mar 3, 2025 06:26 PM",
        "AgentStatus": "Installed Successfully",
        "Language": "Multilingual",
        "Remarks": "Scanning completed successfully",
        "LastContactTime": "Mar 3, 2025 06:26 PM",
        "AgentInstalledDate": "Mar 3, 2025 06:26 PM",
        "AgentInstalledDirectory": "C:\\Program Files (x86)\\DesktopCentral_Agent\\",
        "SearchTag": "--",
        "Notes": "--",
        "OwnerEmail": "--",
        "DeviceFriendlyName": "LinuxMachine16",
        "Health": "Highly Vulnerable",
        "OsPlatform": "Linux",
        "LastSuccessfulScan": "Mar 3, 2025 06:26 PM",
        "MacAddress": "d6:57:b1:a0:54",
        "LoggedOnUsers": "Browser Security Manager",
        "ComputerName": "LinuxMachine16",
        "ServicePack": "--",
        "IpAddress": "153.97.180.148",
        "Domain": "linuxosgroup",
        "Location": "--"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }

▼ Show full

Sample Response: HTTP 500

Server-side error

Copied!

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

▼ Show full

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.