Retrieve Applicable Systems Filter View 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 systems filtered by applicable patch criteria.

Endpoints

Request URL

https://{serverurl}/dcapi/patch/reports/systems

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pageLimitintegerOptional

Number of records per page (default 25)

pageintegerOptional

Page number to retrieve (1-based)

searchColumnstringOptional

Column name to search within

searchValuestringOptional

Value to search for in the specified column

platformstringOptional

1: Windows, 2: Mac, 3: Linux (comma-separated)

domainstringOptional

Domain name filter

branchOfficestringOptional

Branch office name filter

customGroupstringOptional

Custom group name filter

liveStatusstringOptional

1: Agent Live, 2: Agent Down (comma-separated)

kbnumberstringOptional

KB number filter (like match)

mobileViewstringOptional

Set True for mobile-optimized view

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/systems \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

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 entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
AdDescriptionstring

Active Directory description, or --

ComputerNamestring

Name of the computer

ComputerLiveStatusstring

Live status of the computer: 1=Live, 2=Down

CriticalPatchCountstring

Number of critical severity missing patches

DeploymentStatusstring

Current deployment status code

DeviceFriendlyNamestring

Friendly display name of the device

Domainstring

Domain name of the computer

FailedPatchesstring

Number of failed patches

FqdnNamestring

Fully qualified domain name of the system

Healthstring

System health status: 0=Unknown, 1=Healthy, 2=Vulnerable, 3=Highly Vulnerable

ImportantPatchCountstring

Number of important severity missing patches

InstalledBiosPatchesstring

Number of installed BIOS patches

InstalledDriverPatchesstring

Number of installed driver patches

InstalledMsPatchesstring

Number of installed Microsoft patches

InstalledPatchesstring

Number of installed patches

InstalledTpPatchesstring

Number of installed third-party patches

IpAddressstring

IP address of the system

Languagestring

Language of the operating system

LastActionInitiatedOnstring

Time the last action was initiated, or --

LastBootTimestring

Last boot time of the system

LastContactTimestring

Last time the agent contacted the server

LastContactedTimeWithDsstring

Last contacted time with distribution server, or --

LastOperationstring

Last operation performed, or --

LastPatchedTimestring

Last time a patch was applied, or --

LastScanstring

Last scan time

LastSuccessfulScanstring

Last successful scan time, or --

Locationstring

Location of the system, or --

LoggedOnUsersstring

Currently logged on users

LowPatchCountstring

Number of low severity missing patches

MacAddressstring

MAC address of the system

MissingBiosPatchesstring

Number of missing BIOS patches

MissingDriverPatchesstring

Number of missing driver patches

MissingMsPatchesstring

Number of missing Microsoft patches

MissingPatchesstring

Number of missing patches

MissingTpPatchesstring

Number of missing third-party patches

ModeratePatchCountstring

Number of moderate severity missing patches

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 --

ProcessorArchitecturestring

Processor architecture code

RebootRequiredStatusstring

Reboot required status, or null

Remarksstring

Deployment remarks, or --

RemoteOfficestring

Remote office name

ScanRemarksstring

Scan remarks or status message

ScanStatusstring

Scan status code

SearchTagstring

Search tag, or --

ServicePackstring

Service pack or OS version

ShutdownStatusstring

Shutdown status, or null

TimezoneOffsetstring

Timezone offset in minutes

TotalBiosPatchesstring

Total BIOS patches count

TotalDriverPatchesstring

Total driver patches count

TotalMsPatchesstring

Total Microsoft patches count

TotalPatchesstring

Total patches count

TotalTpPatchesstring

Total third-party patches count

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

Systems report data

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 1,
    "messageResponse": [
      {
        "Owner": "--",
        "TotalPatches": "11",
        "LastBootTime": "Dec 14, 2015 10:44 AM",
        "LastScan": "Mar 3, 2025 06:21 PM",
        "ScanRemarks": "Problem while genera...",
        "ShutdownStatus": "--",
        "Remarks": "--",
        "CriticalPatchCount": "2",
        "LastContactTime": "Mar 3, 2025 06:20 PM",
        "LastOperation": "--",
        "MissingDriverPatches": "0",
        "InstalledTpPatches": "9",
        "InstalledPatches": "0",
        "MissingMsPatches": "2",
        "InstalledBiosPatches": "0",
        "DeviceFriendlyName": "WinMachine13",
        "InstalledDriverPatches": "0",
        "LastActionInitiatedOn": "--",
        "ImportantPatchCount": "2",
        "MacAddress": "d4:67:b7:a0:13",
        "TotalTpPatches": "12",
        "ModeratePatchCount": "1",
        "MissingBiosPatches": "0",
        "FailedPatches": "0",
        "ComputerName": "WinMachine13",
        "ServicePack": "Windows 11 Version 21H2 (x64)",
        "Domain": "ZOHOCORP",
        "MissingTpPatches": "3",
        "OperatingSystem": "Windows 11 Enterprise for Virtual Desktops (x64)",
        "ProcessorArchitecture": "0",
        "InstalledMsPatches": "12",
        "LastPatchedTime": "--",
        "TimezoneOffset": "-480",
        "LastContactedTimeWithDs": "--",
        "RemoteOffice": "Default Remote Office",
        "TotalBiosPatches": "0",
        "ComputerLiveStatus": "1",
        "TotalMsPatches": "14",
        "Language": "Spanish",
        "ScanStatus": "228",
        "TotalDriverPatches": "0",
        "SearchTag": "--",
        "Notes": "--",
        "OwnerEmail": "--",
        "RebootRequiredStatus": "--",
        "Health": "Vulnerable",
        "OsPlatform": "Windows",
        "FqdnName": "WINMACHINE13.CSEZ.ZOHOCORPIN.COM",
        "LastSuccessfulScan": "--",
        "LoggedOnUsers": "Application Control Manager",
        "AdDescription": "--",
        "LowPatchCount": "0",
        "MissingPatches": "0",
        "IpAddress": "149.68.109.72",
        "DeploymentStatus": "208",
        "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.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.