# Retrieve Patch Deployment

Retrieves all patch deployment configurations along with their execution status.

**This API endpoint is deprecating soon**

## Endpoints

`GET /api/1.4/patch/viewconfig`

## Request URL

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

## Scope

```
DesktopCentralCloud.PatchMgmt.READ
```

## Header

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

## Request Parameters

### Query Parameters

- **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
- **configname** (string) — Optional
- **configstatusfilter** (string) — Optional  
  InProgress Draft,Executed,Suspended,Deployed,RetryInProgress,Expired
- **viewtypefilter** (string) — Optional
- **configtypefilter** (integer) — Optional
- **platformfilter** (string) — Optional  
  Windows/Mac/Linux

## Sample Request

### Curl

```bash
curl --request GET \
  --url https://appdomain/api/1.4/patch/viewconfig \
  --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/viewconfig"))
        .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/viewconfig", 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/viewconfig"
    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/viewconfig' -Method GET -Headers $headers
```

## Response Parameters

### HTTP 200

**Response Body** — `application/json`

- **message_type** (string)  
  Value: `viewconfig`

- **message_response** (JSON object)  
  Paginated deployment configurations data

  - **viewconfig** (JSON array)  
    Array of deployment configuration objects

    - **collection.collection_id** (long)  
      Unique collection identifier
    - **collection.collection_name** (string)  
      Configuration/collection name
    - **collection.platform_id** (string)  
      Platform ID: 1=Windows, 2=Mac, 3=Linux
    - **os_platform_name** (string)  
      Platform name
    - **collectionstatus.status** (string)  
      Configuration status code
    - **statuslabel** (string)  
      Human-readable status label
    - **statusimage** (string)  
      Status icon image path
    - **collectionstatussummary.total_target_count** (string)  
      Total target systems
    - **collectionstatussummary.success_count** (string)  
      Systems where deployment succeeded
    - **collectionstatussummary.failed_count** (string)  
      Systems where deployment failed
    - **collectionstatussummary.yet_to_apply_count** (string)  
      Systems pending deployment
    - **collectionstatussummary.not_applicable_count** (string)  
      Systems where patch is not applicable
    - **collectionstatussummary.retry_inprogress_count** (string)  
      Systems where retry is in progress
    - **collection.modified_time** (long)  
      Last modified timestamp
    - **collection.is_deleted** (boolean)  
      Whether the configuration is deleted
    - **collection.is_single_config** (boolean)  
      Whether it is a single configuration
    - **first_name** (string)  
      Username of the configuration creator
    - **configurationparams.label** (string)  
      Configuration type label

  - **total** (string)  
    Total number of configurations
  - **limit** (string)  
    Records per page
  - **page** (string)  
    Current page number

- **message_version** (string)  
  API version: 1.0
- **status** (string)  
  Operation status: success
- **response_code** (string)  
  Response code: 200

## Sample Response: HTTP 200

Paginated list of deployment configurations with status

```json
{
  "response_code": 200,
  "message_type": "viewconfig",
  "message_response": {
    "viewconfig": [
      {
        "statusimage": "images/status_executedfailed.gif",
        "collection.collection_name": "Peazip x64 - narun-win10",
        "collectionstatussummary.retry_inprogress_count": 0,
        "collectionstatussummary.total_target_count": 1,
        "collectionstatus.status": 15,
        "collectionstatussummary.not_applicable_count": 0,
        "statuslabel": "dc.db.config.status.draft_download_failed",
        "collectionstatussummary.yet_to_apply_count": 1,
        "os_platform_name": "Windows",
        "collection.modified_time": 1552902864870,
        "collection.is_deleted": false,
        "collection.collection_id": 23708,
        "collectionstatussummary.failed_count": 0,
        "collection.is_single_config": true,
        "configurationparams.label": "dc.conf.conf_param.Install_Patches",
        "collectionstatussummary.success_count": 0,
        "first_name": "admin",
        "collection.platform_id": 1
      }
    ],
    "total": 284,
    "limit": 25,
    "page": 1
  },
  "message_version": "1.0",
  "status": "success"
}
```

## Possible HTTP Status Codes

- **200** — HTTP code

## Rate Limits

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