Retrieve Patch Scan Status 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 patch scan status report for all managed systems.

Endpoint

Request URL

https://{serverurl}/dcapi/patch/reports/scan Copied!

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/scan.v1+jsonapplication/scan.v1+jsonCopied!

- Query Parameters

pageLimitintegerOptional

Number of records to be returned per page. Minimum 1, maximum 1000. Default is 25.

pageintegerOptional

Page number of the result set to be returned. Minimum 1, maximum 100000. Default is 1.

searchColumnstringOptional

Name of the column in which the search value needs to be looked up. Use together with searchValue.

searchValuestringOptional

Text to look up in the column given in searchColumn. Use together with searchColumn.

platformstringOptional

Returns only the systems or patches belonging to the given operating system platform. Accepted values: 1 - Windows, 2 - Mac, 3 - Linux. Multiple values can be given as a comma-separated list.

domainstringOptional

Returns only the systems that belong to the given domain or workgroup. Provide the domain name as shown in Endpoint Central, for example, the NetBIOS name of the domain. Multiple values can be given as a comma-separated list. Get the domain names from Get Domains api

branchOfficestringOptional

Returns only the systems that belong to the given remote office (branch office). Provide the remote office name as configured in Endpoint Central. Multiple values can be given as a comma-separated list. Get the remote office names from Get Remote Offices api

customGroupstringOptional

Returns only the systems that are members of the given custom group. Provide the custom group name as configured in Endpoint Central. Multiple values can be given as a comma-separated list. Get the custom group names from Get Custom Groups api

healthstringOptional

Returns only the systems with the given patch health (vulnerability) status. Accepted values: 0 - Not Available, 1 - Healthy, 2 - Vulnerable, 3 - Highly Vulnerable. Multiple values can be given as a comma-separated list.

liveStatusstringOptional

Returns only the systems with the given agent live status. Accepted values: 1 - Live, 2 - Down, 3 - Unknown. Multiple values can be given as a comma-separated list.

computerNamestringOptional

Returns only the systems whose name contains the given text.

mobileViewstringOptional

Set to True to get a compact response meant for the mobile app, which also contains the identifiers needed to perform follow-up actions. Leave empty for the default response.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/scan \
  --header 'Accept: application/scan.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
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 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

- 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

Sample Response: HTTP 200

Scan status report data

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

Sample Response: HTTP 500

Server-side error

Copied!
  {
    "error_code": "INTERNAL_ERROR",
    "error_description": "dc.rest.api_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.