Retrieve System Patch Compliance Report

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 system compliance report showing patch compliance status per system.

Request URL

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

Scope

PatchMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/patch/reports/systemCompliance \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
Show full

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 system compliance entries

Show Sub-Attributes
JSON object
Show Sub-Attributes
ApplicablePatchesstring

Number of applicable patches, or --

CompliancePercentagestring

Compliance percentage (e.g., 0%, 85%)

ComplianceStatusstring

Compliance status: Compliant, Non-compliant

ComputerNamestring

Name of the computer

Domainstring

Domain name of the computer

InstalledPatchesstring

Number of installed patches, or --

IpAddressstring

IP address of the system

LastBootTimestring

Last boot time of the system

LastContactTimestring

Last time the agent contacted the server

LastContactedTimeWithDsstring

Last contacted time with distribution server, or --

LastPatchedTimestring

Last time a patch was applied, or --

LastScanstring

Last scan time

LastSuccessfulScanstring

Last successful scan time

Locationstring

Location of the system, or --

LoggedOnUsersstring

Currently logged on users

MissingPatchesstring

Number of missing patches, or --

Notesstring

Admin notes, or --

OperatingSystemstring

Full operating system name and architecture

OsPlatformstring

Platform: Windows, Mac, Linux

Ownerstring

Owner of the system, or --

OwnerEmailstring

Email of the system owner, or --

RemoteOfficestring

Remote office name

SearchTagstring

Search tag, or --

ServicePackstring

Service pack or OS version

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

Paginated system compliance data

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 1,
    "messageResponse": [
      {
        "CompliancePercentage": "0%",
        "OperatingSystem": "Windows 11 Professional Edition (x64)",
        "ApplicablePatches": "--",
        "Owner": "--",
        "ComplianceStatus": "Non-compliant",
        "OsPlatform": "Windows",
        "LastPatchedTime": "--",
        "LastSuccessfulScan": "Mar 3, 2025 06:26 PM",
        "LastContactedTimeWithDs": "--",
        "RemoteOffice": "localOfficeOne",
        "LastBootTime": "Dec 14, 2015 10:44 AM",
        "LastScan": "Mar 3, 2025 06:26 PM",
        "LoggedOnUsers": "Browser Security Manager",
        "LastContactTime": "Mar 3, 2025 06:26 PM",
        "MissingPatches": "--",
        "ComputerName": "WinMachine6",
        "ServicePack": "Windows 11 Version 22H2 (x64)",
        "InstalledPatches": "--",
        "IpAddress": "252.0.118.105",
        "Domain": "linuxosgroup",
        "SearchTag": "--",
        "Notes": "--",
        "OwnerEmail": "--",
        "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.