# Retrieve Patches with Advanced Filtering

Retrieves patches with support for advanced filtering such as approvalStatus, severity and platform etc.

## Endpoint

`POST /dcapi/patch/reports/allPatches`

## Request

### Request URL

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

### Scope

`PatchMgmt.CREATE`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Sample Request

```curl
curl --request POST \
  --url https://appdomain/dcapi/patch/reports/allPatches \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP code 200

Response Body — `application/json`

| Parameter | Type | Description |
|---|---|---|
| Links | JSON object | Pagination links for next and previous pages |
| messageResponse | JSON array | Array of patch-system mapping 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 |

### Sample Response: HTTP 200

All patches with advanced filters

```json
{
  "metadata": {
    "limit": 25,
    "page": 1
  },
  "totalRecords": "1",
  "messageResponse": [
    {
      "resource_name_transform": "DESKTOP-U9VV1HA",
      "agent_version_transform": "11.5.2616.01.W",
      "deployer_first_name": null,
      "sqnumber": "14.50.35719.0",
      "os_language": "1",
      "install_error_code": null,
      "platform_name_transform": "Windows",
      "patch_install_status_label_transform": "--",
      "bulletin_id": "MSWU-3550",
      "update_name": "Non Security Updates",
      "patch_size": "6876208",
      "image_name": null,
      "patch_description_transform": "Windows Malicious Software Removal Tool x64 - Dec 2025 (KB890830)",
      "patch_uninstall_status": "0",
      "service_pack": "Windows 10 Version 22H2 (x64)",
      "os_name_transform": "Windows 11 Professional Edition (x64)",
      "resourcemacip_resource_id": "307",
      "patch_size_transform": "80.41 MB",
      "domain_netbios_name_transform": "WORKGROUP",
      "patch_uninstall_status_transform": "Not Supported",
      "patch_status": null,
      "patch_install_status_image": null,
      "patch_id": "112861",
      "patch_name": "VC_redist.x86__14.50.35719.0.exe",
      "update_name_transform": "Security Updates",
      "patch_description": "Microsoft Visual C++ 2015-2022 Redistributable (x86) (14.50.35719.0)",
      "branch_office_name_transform": "Local Office",
      "i18n_transform": "",
      "os_platform": "1",
      "agent_last_contact_time_transform": "May 20, 2026 02:49 PM",
      "agent_logged_on_users": "Administrator",
      "patch_name_transform": "Windows-kb890830-x64-v5.138.exe",
      "sqnumber_transform": "890830",
      "vendor_name": "Microsoft Corporation",
      "superceded_by": "NA",
      "i18n": "dc.patch.patchinfo.English",
      "user_id": null,
      "config_id": null,
      "patch_released_time_transform": "Dec 9, 2025",
      "deploy_remarks_args": null,
      "friendly_name_transform": "DESKTOP-U9VV1HA",
      "superceded_by_transform": "NA",
      "installed_time": null,
      "collection_name": null,
      "patch_affected_status_label_transform": "Installed",
      "computer_status_update_time": "1779101474204",
      "patch_affected_status_image": "images/stop.png",
      "deploy_remarks_transform": "--",
      "collection_name_transform": "--",
      "branch_office_name": "Local Office",
      "patch_updated_time": null,
      "installed_time_transform": "--",
      "agent_last_contact_time": "1779268806000",
      "bulletin_id_transform": "MSRT-001",
      "domain_netbios_name": "WORKGROUP",
      "patch_supported_time_transform": "Dec 9, 2025",
      "deploy_remarks": null,
      "platform": "1",
      "patch_released_time": "1764067447000",
      "patch_id_transform": "43089",
      "ip_address_transform": "172.19.69.59",
      "mac_address": "00:0c:29:d4:19:9d",
      "severity_transform": "Moderate",
      "platform_name": "Windows",
      "patch_type": "1",
      "first_name": null,
      "severity": "0",
      "affected_patch_status": "202",
      "friendly_name": "DESKTOP-N7T1LKT",
      "pmseverity_name": "Unrated",
      "managedcomputer_resource_id": "307",
      "deployer_first_name_transform": "--",
      "deployment_status": null,
      "config_id_transform": "--",
      "agent_logged_on_users_transform": "Windows",
      "severity_name": "dc.rep.patchreport.unrated",
      "label": null,
      "ip_address": "192.168.130.128",
      "vendor_name_transform": "Microsoft",
      "service_pack_transform": "Windows 11 Version 25H2 (x64)",
      "patch_supported_time": "1764067447000",
      "agent_version": "11.5.2616.01.W",
      "patch_install_status_label": null,
      "patch_affected_status_label": "dc.common.MISSING",
      "mac_address_transform": "00:15:5d:46:ec:00",
      "agent_last_bootup_time": "1778757478000",
      "resource_id": "307",
      "os_name": "Windows 10 Professional Edition (x64)",
      "computer_live_status": "1",
      "resource_name": "DESKTOP-N7T1LKT"
    }
  ],
  "totalPages": 2,
  "Links": {
    "next": "/dcapi/patch/reports/allPatches?page=2&pageLimit=25",
    "prev": null
  },
  "status": "success"
}
```

### HTTP code 500

Response Body — `application/json`

| Parameter | Type | Description |
|---|---|---|
| error_code | string | Error code: INTERNAL_ERROR for server-side failures |
| error_description | string | Localized error description: dc.rest.api_internal_error |

### Sample Response: HTTP 500

Server-side error

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

### Possible Response Codes

| Code | Type |
|---|---|
| 200 | HTTP code |
| 500 | HTTP code |

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