# Retrieve Patch Scan Status Report

Retrieves the patch scan status report for all managed systems.

**This API endpoint is deprecating soon**

## Endpoint

`GET /dcapi/patch/reports/scan`

## Request

### Request URL

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

### 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
- **branchOffice** `string` *(Optional)*: Branch office name filter
- **customGroup** `string` *(Optional)*: Custom group name filter
- **health** `string` *(Optional)*: 0: Unknown — patch status is not available, 1: Healthy — system is up-to-date, 2: Vulnerable — system has missing patches, 3: Highly Vulnerable — system has critical or high-risk missing patches
- **liveStatus** `string` *(Optional)*: 1: Agent Live, 2: Agent Down (comma-separated)
- **computerName** `string` *(Optional)*: Computer name filter
- **mobileView** `string` *(Optional)*: Set True for mobile-optimized view returning Resource_ID

### Sample Request

```curl
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/scan \
  --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 scan status report 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

Scan status report data

```json
{
  "metadata": {
    "limit": 25,
    "page": 1
  },
  "totalRecords": 1,
  "messageResponse": [
    {
      "OperatingSystem": "Red Hat Enterprise Linux 8 (x86_64)",
      "LastScanStatus": "Scanning Completed",
      "Owner": "--",
      "AgentVersion": "10.0.337.L",
      "LastContactedTimeWithDs": "--",
      "RemoteOffice": "localOfficeOne",
      "LastBootTime": "Dec 14, 2015 10:44 AM",
      "LastScan": "Mar 3, 2025 06:26 PM",
      "AgentStatus": "Installed Successfully",
      "Language": "Multilingual",
      "Remarks": "Scanning completed successfully",
      "LastContactTime": "Mar 3, 2025 06:26 PM",
      "AgentInstalledDate": "Mar 3, 2025 06:26 PM",
      "AgentInstalledDirectory": "C:\\Program Files (x86)\\DesktopCentral_Agent\\",
      "SearchTag": "--",
      "Notes": "--",
      "OwnerEmail": "--",
      "DeviceFriendlyName": "LinuxMachine16",
      "Health": "Highly Vulnerable",
      "OsPlatform": "Linux",
      "LastSuccessfulScan": "Mar 3, 2025 06:26 PM",
      "MacAddress": "d6:57:b1:a0:54",
      "LoggedOnUsers": "Browser Security Manager",
      "ComputerName": "LinuxMachine16",
      "ServicePack": "--",
      "IpAddress": "153.97.180.148",
      "Domain": "linuxosgroup",
      "Location": "--"
    }
  ],
  "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"
}
```

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