Retrieve Patch Summary by Remote Office

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 patch summary metrics grouped by remote office.

Request URL

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

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

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/roSummary \
  --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 remote office summary entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
ApplicablePatchesstring

Total number of applicable patches for this remote office

HealthUnknownSystemsstring

Number of systems with unknown health status

HealthySystemsstring

Number of healthy systems

HighlyVulnerableSystemsstring

Number of highly vulnerable systems

InstalledPatchesstring

Total number of installed patches

ManagedComputersstring

Total number of managed computers

MissingPatchesstring

Total number of missing patches

RemoteOfficeNamestring

Name of the remote office

VulnerableSystemsstring

Number of vulnerable systems

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

- 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

Remote office patch summary

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 2,
    "messageResponse": [
      {
        "ApplicablePatches": "473",
        "MissingPatches": "457",
        "VulnerableSystems": "0",
        "HealthUnknownSystems": "2",
        "RemoteOfficeName": "Default Remote Office",
        "ManagedComputers": "14",
        "InstalledPatches": "16",
        "HighlyVulnerableSystems": "10",
        "HealthySystems": "2"
      },
      {
        "ApplicablePatches": "233",
        "MissingPatches": "193",
        "VulnerableSystems": "2",
        "HealthUnknownSystems": "0",
        "RemoteOfficeName": "localOfficeOne",
        "ManagedComputers": "10",
        "InstalledPatches": "40",
        "HighlyVulnerableSystems": "2",
        "HealthySystems": "6"
      }
    ],
    "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.