# Retrieve Patch Scan System List

Retrieves the list of all systems along with their patch scan status.

**This API endpoint is deprecating soon**

## Endpoints

[GET /api/1.4/patch/scandetails](https://www.manageengine.com/products/desktop-central/help/api/cloud/patch-legacy-get-scan-details.html)

## Request

### Request URL

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

### Scope

`DesktopCentralCloud.PatchMgmt.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Query Parameters

- **resid** `string` *(Optional)*: Filter for system with a resource id
- **domainfilter** `string` *(Optional)*: Get domain list from api/1.4/desktop/serverproperties
- **platformfilter** `string` *(Optional)*: Windows/Mac/Linux
- **branchofficefilter** `string` *(Optional)*: Get branch office list from api/1.4/desktop/serverproperties
- **customgroupfilter** `string` *(Optional)*: Get Custom Group list from api/1.4/desktop/serverproperties
- **healthfilter** `integer` *(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
- **livestatusfilter** `integer` *(Optional)*: 1: Agent Live (agent is running), 2: Agent Down (agent is not responding)
- **searchvalue** `string` *(Optional)*
- **searchcolumn** `string` *(Optional)*
- **searchtype** `string` *(Optional)*
- **sortorder** `string` *(Optional)*
- **orderby** `string` *(Optional)*
- **pagelimit** `string` *(Optional)*: Number of records per page.
- **page** `integer` *(Optional)*: Current page number for pagination.
- **customerid** `long` *(Optional)*
- **agentinstallationstatusfilter** `integer` *(Optional)*: 21: Not Installed (agent is not installed), 22: Installed (agent is installed)
- **scanstatusfilter** `integer` *(Optional)*

### Sample Request

```curl
curl --request GET \
  --url https://appdomains/api/1.4/patch/scandetails \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response

### HTTP Code 200

#### Response Body: application/json

- `JSON Object`
  - **message_type** `string`: Value: scandetails
  - **message_response** `JSON Object`: Paginated scan details data
  - **message_version** `string`: API version: 1.0
  - **status** `string`: Operation status: success
  - **response_code** `string`: Response code: 200

### Possible Response Codes

- **200** `HTTP code`

### Sample Response: HTTP 200

Paginated list of systems with scan status

```json
{
  "response_code": 200,
  "message_type": "scandetails",
  "message_response": {
    "total": 94,
    "limit": 25,
    "page": 1,
    "scandetails": [
      {
        "branch_office_name": "Local Office",
        "scan_status": 228,
        "resource.name": "WIN-SERVER-01",
        "resource_health_status": 3,
        "scan_remarks": "dc.patch.util.Scanning_completedsuccessfully",
        "os_platform": 1,
        "ip_address": "192.168.1.100",
        "branch_office_id": 1,
        "os_platform_name": "Windows",
        "agent_version": "10.0.267.W",
        "mac_address": "00:0c:29:7e:51:a7",
        "resource.domain_netbios_name": "WORKGROUP",
        "service_pack": "Windows 10 Version 1803 (x64)",
        "resource_id": 47707,
        "installation_status": 22,
        "os_name": "Windows 10 Professional Edition (x64)",
        "computer_live_status": 1,
        "last_scan_time": 1552904526258,
        "last_successful_scan": 1552904526258
      }
    ]
  },
  "message_version": "1.0",
  "status": "success"
}
```

## API Rate Limit

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

**Duration:** 1 minute | **Threshold:** 30 | **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.