# List Patch Status Across Computers

**Deprecating soon**

This API provides detailed information about the installation status of a given patch on all applicable computers within the Endpoint Central environment.

**This API endpoint is deprecating soon**

## Endpoints

`GET` /api/1.4/patch/allpatchdetails

## Request URL

```
https://{serverurl}/api/1.4/patch/allpatchdetails
```

## Scope

```
DesktopCentralCloud.PatchMgmt.READ
```

## Header

```
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
```

## Request Parameters

### Query Parameters

- **patchid** (string, Optional)  
  Filter for patch with a particular id

- **bulletinid** (string, Optional)

- **severityfilter** (integer, Optional)  
  0: Unrated — no severity assigned  
  1: Low — minimal impact  
  2: Moderate — average impact  
  3: Important — significant impact  
  4: Critical — high impact or security risk

- **patchstatusfilter** (integer, Optional)  
  201: Installed — patch is already installed  
  202: Missing — patch is not installed

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

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

- **languagefilter** (integer, Optional)

- **patchtypefilter** (integer, Optional)  
  0: Security Updates  
  1: Critical Updates  
  2: Third-Party Updates  
  3: Updates  
  4: Definition Updates  
  5: Service Packs  
  6: Feature Packs  
  7: Rollups  
  8: Tools  
  9: Driver  
  10: Optional Updates  
  11: Preview Rollups  
  12: BIOS

- **deploymentstatusfilter** (integer, Optional)

## Sample Request

### Curl

```bash
curl --request GET \
  --url https://appdomain/api/1.4/patch/allpatchdetails \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

### Java

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/1.4/patch/allpatchdetails"))
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse<string> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}
```

### Python

```python
import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = { 'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/api/1.4/patch/allpatchdetails", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

### Deluge

```javascript
headersMap = Map();
headersMap.put("Accept", "application/json");

response = invokeUrl
[
    url: "https://appDomain/api/1.4/patch/allpatchdetails"
    type: GET
    headers: headersMap
    connection: connection_name
]

info response;
```

### PowerShell

```powershell
$headers=@{}
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/1.4/patch/allpatchdetails' -Method GET -Headers $headers
```

## Response Parameters

### HTTP Code 200

Response Body: `application/json`

- **Links** (JSON object)  
  Pagination links for next and previous pages  
  - **next** (string) — URL for the next page of results, or null if on the last page  
  - **prev** (string) — URL for the previous page of results, or null if on the first page  

- **messageResponse** (JSON array)  
  Array of patch-system mapping entries  

  - **affected_patch_status** (string) — Affected patch status code  
  - **agent_last_bootup_time** (string) — Agent last bootup time in epoch milliseconds  
  - **agent_last_contact_time** (string) — Agent last contact time in epoch milliseconds  
  - **agent_last_contact_time_transform** (string) — Formatted agent last contact time  
  - **agent_logged_on_users** (string) — Logged on users on the agent  
  - **agent_logged_on_users_transform** (string) — Transformed logged on users  
  - **agent_version** (string) — Agent version string  
  - **agent_version_transform** (string) — Transformed agent version  
  - **branch_office_name** (string) — Branch office name  
  - **branch_office_name_transform** (string) — Transformed branch office name  
  - **bulletin_id** (string) — Security bulletin identifier  
  - **bulletin_id_transform** (string) — Transformed bulletin ID  
  - **collection_name** (string) — Collection name, or null  
  - **collection_name_transform** (string) — Transformed collection name  
  - **computer_live_status** (string) — Computer live status code  
  - **computer_status_update_time** (string) — Computer status update time in epoch milliseconds  
  - **config_id** (string) — Configuration ID, or null  
  - **config_id_transform** (string) — Transformed configuration ID  
  - **deploy_remarks** (string) — Deployment remarks, or null  
  - **deploy_remarks_args** (string) — Deployment remarks arguments, or null  
  - **deploy_remarks_transform** (string) — Transformed deployment remarks  
  - **deployer_first_name** (string) — Deployer first name, or null  
  - **deployer_first_name_transform** (string) — Transformed deployer name  
  - **deployment_status** (string) — Deployment status, or null  
  - **domain_netbios_name** (string) — Domain NetBIOS name  
  - **domain_netbios_name_transform** (string) — Transformed domain name  
  - **first_name** (string) — Name of the user who approved the patch  
  - **first_name_transform** (string) — Transformed approving user name  
  - **friendly_name** (string) — Friendly computer name  
  - **friendly_name_transform** (string) — Transformed friendly name  
  - **i18n** (string) — Internationalization language  
  - **i18n_transform** (string) — Transformed i18n value  
  - **image_name** (string) — Image path for approval status  
  - **install_error_code** (string) — Installation error code, or null  
  - **installed_time** (string) — Installation time in epoch milliseconds, or null  
  - **installed_time_transform** (string) — Formatted installation time  
  - **ip_address** (string) — IP address of the system  
  - **ip_address_transform** (string) — Transformed IP address  
  - **label** (string) — Approval status label key  
  - **label_transform** (string) — Transformed approval status display  
  - **mac_address** (string) — MAC address of the system  
  - **mac_address_transform** (string) — Transformed MAC address  
  - **managedcomputer_resource_id** (string) — Managed computer resource ID  
  - **os_language** (string) — OS language code  
  - **os_name** (string) — Operating system name  
  - **os_name_transform** (string) — Transformed OS name  
  - **os_platform** (string) — OS platform code  
  - **patch_affected_status_image** (string) — Image path for patch affected status  
  - **patch_affected_status_label** (string) — Patch affected status label key  
  - **patch_affected_status_label_transform** (string) — Transformed patch affected status  
  - **patch_description** (string) — Full description of the patch  
  - **patch_description_transform** (string) — Transformed patch description  
  - **patch_id** (string) — Unique patch identifier  
  - **patch_id_transform** (string) — Transformed patch ID  
  - **patch_install_status_image** (string) — Image path for install status, or null  
  - **patch_install_status_label** (string) — Install status label, or null  
  - **patch_install_status_label_transform** (string) — Transformed install status label  
  - **patch_name** (string) — Patch file name  
  - **patch_name_transform** (string) — Transformed patch file name  
  - **patch_released_time** (string) — Patch release time in epoch milliseconds  
  - **patch_released_time_transform** (string) — Formatted patch release date  
  - **patch_size** (string) — Patch file size in bytes  
  - **patch_size_transform** (string) — Formatted patch file size  
  - **patch_status** (string) — Patch status code  
  - **patch_supported_time** (string) — Patch supported time in epoch milliseconds  
  - **patch_supported_time_transform** (string) — Formatted patch supported date  
  - **patch_type** (string) — Patch type code  
  - **patch_uninstall_status** (string) — Uninstall support status code  
  - **patch_uninstall_status_transform** (string) — Transformed uninstall status display  
  - **patch_updated_time** (string) — Last updated time in epoch milliseconds  
  - **patch_updated_time_transform** (string) — Formatted last updated date and time  
  - **platform** (string) — Platform code: 1=Windows, 2=Mac, 3=Linux  
  - **platform_name** (string) — Platform display name  
  - **pmseverity_name** (string) — Severity display name  
  - **resource_id** (string) — Resource identifier  
  - **resource_name** (string) — Resource/computer name  
  - **resource_name_transform** (string) — Transformed resource name  
  - **resourcemacip_resource_id** (string) — Resource MAC/IP resource ID  
  - **service_pack** (string) — Service pack version  
  - **service_pack_transform** (string) — Transformed service pack  
  - **severity** (string) — Severity code  
  - **severity_name** (string) — Severity label key  
  - **severity_transform** (string) — Transformed severity display  
  - **sqnumber** (string) — Software version/sequence number  
  - **sqnumber_transform** (string) — Transformed version number  
  - **superceded_by** (string) — Superceded by patch ID, or NA  
  - **superceded_by_transform** (string) — Transformed superceded by value  
  - **update_name** (string) — Update type name  
  - **update_name_transform** (string) — Transformed update type name  
  - **user_id** (string) — User ID of approver  
  - **vendor_name** (string) — Vendor name  
  - **vendor_name_transform** (string) — Transformed vendor name  

- **metadata** (JSON object)  
  Pagination metadata  
  - **limit** (string) — Number of records per page  
  - **page** (string) — Current page number  

- **status** (string) — Operation result: success  
- **totalPages** (string) — Total number of pages available  
- **totalRecords** (string) — Total number of records matching the query  

## Possible HTTP Status Codes

- **200** — HTTP code

## Sample Response: HTTP 200

Paginated list of patch status across all applicable systems

```json
{
  "response_code": 200,
  "message_type": "allpatchdetails",
  "message_response": {
    "total": 5,
    "allpatchdetails": [
      {
        "severity": 3,
        "branch_office_name": "Local Office",
        "patch_id": 23956,
        "resource.name": "COMPUTER-01",
        "patch_name": "SQLPreReqHandler_KB4057116_x64.exe",
        "patch_description": "Security update for SQL Server 2012 SP4 x64 (KB4057116)",
        "vendor_name": "Microsoft",
        "deployment_status": "--",
        "superceded_by": "NA",
        "ip_address": "172.24.143.191",
        "bulletin_id": "MS18-JAN9",
        "update_name": "Security Updates",
        "patch_released_time": 1515715200000,
        "patch_size": 0,
        "affectedpatchstatusdefn.label": "dc.common.INSTALLED",
        "agent_version": "10.0.267.W",
        "resource.domain_netbios_name": "DOMAIN",
        "service_pack": "Windows Server 2012 R2 Gold (x64)",
        "patch_uninstall_status": 0,
        "os_name": "Windows Server 2012 R2 Standard Edition (x64)",
        "patch_type": 0,
        "resource.resource_id": 50924,
        "pmseverity.name": "Important",
        "patch_status": 211
      }
    ],
    "limit": 25,
    "page": 1
  },
  "message_version": "1.0",
  "status": "success"
}
```

## Rate Limiting

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