# Retrieve Patch Summary by Remote Office

Retrieves patch summary metrics grouped by remote office.

## Endpoints

`GET /dcapi/patch/reports/roSummary`

## Request

### Request URL

`https://{server-hostname}:8383/dcapi/patch/reports/roSummary`

### Scope

`PatchMgmt.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Sample Request

```curl
curl --request GET \
  --url https://appdomain/dcapi/patch/reports/roSummary \
  --header 'Authorization:  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 summary entries
  - **metadata** — JSON object
    - Pagination metadata
  - **status** — string
    - Operation result: success
  - **totalPages** — string
    - Total number of pages available
  - **totalRecords** — string
    - Total number of records

### 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 patch summary

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

### HTTP 500

Server-side error

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

## Rate Limit

![ ](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.