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://{server-hostname}:8383/dcapi/patch/reports/roCompliance

Scope

PatchMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/patch/reports/roCompliance \
  --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 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 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 compliance data

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