Retry Patch
Service name: patch_retry
Base URL
https://{SERVER}/api/?apikey={yourAPIkey}&service=patch_retry
Description
Retry specific software patches on the specified device.
Parameters
Required parameters
Add required parameters immediately after the base URL.
https://{SERVER}/api/?apikey={yourAPIkey}&service=patch_retry&required_parameters={parameter-value}
| Parameter | Description | Type | Options | Default | 
|---|---|---|---|---|
deviceid  | 
  The deviceid must be a valid id.  | 
  number  | 
  0  | 
  0  | 
patchids  | 
  The patchids parameter is a sequence of comma separated patchid's as return in the patch_list_all    | 
  string  | 
  0  | 
  0  | 
Optional parameters
Add optional parameters after the required parameters in the base URL.
https://{SERVER}/api/?apikey={yourAPIkey}&service=patch_ignore&required_parameters={parameter-value}&optional_parameters={parameter-value}
| Parameter | Description | Type | Options | Default | 
|---|---|---|---|---|
| describe | Optional. Returns a description of the entered call, the available parameters, an example of its output, and returned fields with descriptions. | boolean | true | 0 | 
Determine parameter values
Use the following associated service calls to determine parameter values.
| Parameter | Call | URL Format | 
|---|---|---|
| patchid | patch_list_all | https://{SERVER}/api/?apikey={yourAPIkey}&service=patch_list_all&deviceid=DEVICEID | 
| deviceid | list_devices_at_client | https://{SERVER}/api/?apikey={yourAPIkey}&service=list_devices_at_client&clientid=CLIENTID&devicetype=server | 
| list_servers | https://{SERVER}/api/?apikey={yourAPIkey}&service=list_servers&siteid=SITEID | |
| list_workstations | https://{SERVER}/api/?apikey={yourAPIkey}&service=list_workstations&siteid=SITEID | |
| siteid | list_sites | https://{SERVER}/api/?apikey={yourAPIkey}&service=list_sites&clientid=CLIENTID | 
| clientid | list_clients | https://{SERVER}/api/?apikey={yourAPIkey}&service=list_clients | 
Examples
Patch Reprocess
https://SERVER/api/?apikey=yourAPIkey&service=patch_retry&deviceid=DEVICEID&patchids=PATCHID,PATCHID,PATCHID
Example response
<result created="2024-10-01T12:47:15+01:00" host="SERVER" status="OK" >
 <msg>Retrying patches: 4,5 Patches already applied: 1,6</msg>
</result>Returned fields
| Field | Type | Can Be Empty | Description | 
|---|---|---|---|
| msg | string | yes | Message related to the action status. | 
Updated 3 months ago