Retrieve Remote Office 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 remote office compliance report with patch status per remote office.

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/roCompliance.v1+jsonapplication/roCompliance.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

severitystringOptional

Returns only the patches of the given severity. Accepted values: 0 - Unrated, 1 - Low, 2 - Moderate, 3 - Important, 4 - Critical. Multiple values can be given as a comma-separated list.

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

compliancestringOptional

Returns only the records with the given compliance state. Accepted values: 0 - Non-Compliant, 1 - Compliant. Multiple values can be given as a comma-separated list.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/roCompliance \
  --header 'Accept: application/roCompliance.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 remote office compliance entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
CompliancePercentagestring

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

ComplianceStatusstring

Compliance status: Compliant, Non-compliant

CompliantSystemsstring

Number of compliant systems

InstalledPatchesstring

Number of installed patches

ManagedComputersstring

Number of managed computers in the remote office

MissingPatchesstring

Number of missing patches

NonCompliantSystemsstring

Number of non-compliant systems

RemoteOfficeNamestring

Name of the remote office

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

Remote office compliance data

Copied!
  {
    "Links": {
      "next": null,
      "prev": null
    },
    "messageResponse": [
      {
        "CompliancePercentage": "0%",
        "ComplianceStatus": "Non-compliant",
        "CompliantSystems": "0",
        "InstalledPatches": "40",
        "ManagedComputers": "10",
        "MissingPatches": "193",
        "NonCompliantSystems": "10",
        "RemoteOfficeName": "localOfficeOne"
      },
      {
        "CompliancePercentage": "0%",
        "ComplianceStatus": "Non-compliant",
        "CompliantSystems": "0",
        "InstalledPatches": "16",
        "ManagedComputers": "14",
        "MissingPatches": "457",
        "NonCompliantSystems": "14",
        "RemoteOfficeName": "Default Remote Office"
      }
    ],
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "status": "success",
    "totalPages": 1,
    "totalRecords": 2
  }
                
▼ 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.