# Retrieve Remote Office Compliance Report

Retrieves the remote office compliance report with patch status per remote office.

## Endpoints

[GET /dcapi/patch/reports/roCompliance](https://www.manageengine.com/products/desktop-central/help/api/cloud/patch-get-rocompliance-report.html)

## Request URL

https://[*{serverurl}*](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/dcapi/patch/reports/roCompliance

## Scope

`DesktopCentralCloud.PatchMgmt.READ`

## Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Query Parameters

- **pageLimit** `integer` *(Optional)*: Number of records per page (default 25)
- **page** `integer` *(Optional)*: Page number to retrieve (1-based)
- **searchColumn** `string` *(Optional)*: Column name to search within
- **searchValue** `string` *(Optional)*: Value to search for in the specified column
- **platform** `string` *(Optional)*: 1: Windows, 2: Mac, 3: Linux (comma-separated)
- **domain** `string` *(Optional)*: Domain name filter
- **severity** `string` *(Optional)*: 0: Unrated, 1: Low, 2: Moderate, 3: Important, 4: Critical (comma-separated)
- **branchOffice** `string` *(Optional)*: Branch office name filter
- **compliance** `string` *(Optional)*: Compliance status filter (comma-separated)

## Sample Request

```curl
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/roCompliance \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP code 200

#### Response Body — application/json

`JSON Object`

- **Links** `JSON Object`: Pagination links for next and previous pages
- **messageResponse** `JSON Array`: Array of remote office compliance entries
- **metadata** `JSON Object`: Pagination metadata
- **status** `string`: Operation result: success
- **totalPages** `string`: Total number of pages available
- **totalRecords** `string`: Total number of records matching the query

### HTTP code 500

#### Response Body — application/json

`JSON Object`

- **error_code** `string`: Error code: INTERNAL_ERROR for server-side failures
- **error_description** `string`: Localized error description: dc.rest.api_internal_error

## Possible Response Codes

- **200** `HTTP code`
- **500** `HTTP code`

## Sample Response: HTTP 200

Remote office compliance data

```json
{
  "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"
}
```

## Sample Response: HTTP 500

Server-side error

```json
{
  "error_description": "dc.rest.api_internal_error",
  "error_code": "INTERNAL_ERROR"
}
```

## API Rate Limits

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

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