Endpoint
/api/v2/tenants/{tenantId}/patches/configurations/{id}
Deletes a patch configuration.
Path Parameters
tenantIdstring
idstring
Responses
OK
Endpoint
/api/v2/tenants/{tenantId}/patches/configurations/{id}
Gets patch configuration details.
Path Parameters
tenantIdstring
idstring
Responses
OK
approvalstring
approvalTypeobject
Child Parameters
- approvalType.approvalReason
- (Optional) Approval reason for executing patches.
- approvalType.approvalType
- Approval type for executing patches. - 0- Manual, 1- Auto
descriptionstring
Description for patch configuration.
enablePatchingboolean
(Optional) Enable patching.
idstring
installationstring
maintenancePeriodinteger
(Optional) Maintenance period for the patches.
patchConfigNamestring
Patch configuration name.
rebootOptionsobject
Child Parameters
- rebootOptions.forceReboot
- Force reboot after execution of patches.
- rebootOptions.rebootRequired
- Reboot required after execution of patches.
scheduleJobobject
Child Parameters
- scheduleJob.client
- scheduleJob.entities
- Resources in which the patches are executed.
- scheduleJob.name
- scheduleJob.schedule
- (Optional sub-fields) Schedule settings.
- scheduleJob.script
sourcestring
{
"approval": "MANUAL",
"approvalType": {
"approvalReason": "",
"approvalType": 0
},
"description": "desc",
"enablePatching": false,
"id": "PATCHCONF-d708f385-e17f-41a0-b602-bf9d69a1f70d",
"installation": "AUTO",
"patchConfigName": "patch1",
"rebootOptions": {
"forceReboot": false,
"rebootRequired": false
},
"scheduleJob": {
"client": {
"activated": true,
"id": 4,
"name": "EHR",
"uniqueId": "client_4"
},
"entities": [
{
"resource": {
"clientUniqueId": "client_4",
"generalInfo": {
"aliasName": "",
"hostName": "rewss",
"ipAddresses": "",
"osName": "",
"resourceName": "test vm",
"resourceType": "Desktop"
},
"id": "eb1c8614-9593-4185-98f7-ac4266e180f1",
"type": "DEVICE"
}
}
],
"name": "PATCHCONF-d708f385-e17f-41a0-b602-bf9d69a1f70d",
"schedule": {
"pattern": {
"frequency": "everyday",
"type": "daily"
},
"startDate": "2019-05-23T00:00:00+0000"
},
"script": {
"jobType": "missingPatchesDownloadUpdate"
}
},
"source": "LOCAL"
}
Endpoint
/api/v2/tenants/{tenantId}/patches/configurations/{id}
Updates a patch configuration.
Notes
- Approved Windows patches will be installed on the device during the scheduled installation window.
- The device will be immediately rebooted following any patch that requiring a reboot.
- Standard checks are performed on rebooted devices to ensure the device is operating properly.
Path Parameters
tenantIdstring
idstring
approvalstring
approvalTypeobject
Child Parameters
- approvalType.approvalReason
- (Optional) Approval reason for executing patches.
- approvalType.approvalType
- Approval type for executing patches. - 0- Manual, 1- Auto
descriptionstring
Description for patch configuration.
enablePatchingboolean
(Optional) Enable patching.
idstring
installationstring
maintenancePeriodinteger
(Optional) Maintenance period for the patches.
patchConfigNamestring
Patch configuration name.
rebootOptionsobject
Child Parameters
- rebootOptions.forceReboot
- Force reboot after execution of patches.
- rebootOptions.rebootRequired
- Reboot required after execution of patches.
scheduleJobobject
Child Parameters
- scheduleJob.client
- scheduleJob.entities
- Resources in which the patches are executed.
- scheduleJob.name
- scheduleJob.schedule
- (Optional sub-fields) Schedule settings.
- scheduleJob.script
sourcestring
{
"approvalType": {
"approvalReason": "testing data",
"approvalType": 1
},
"description": "testing",
"enablePatching": true,
"id": "PATCHCONF-9db1451f-1441-4bd9-90b9-aa371fc11e6d",
"maintenancePeriod": 60,
"patchConfigName": "Test_Patch_Config",
"rebootOptions": {
"forceReboot": true,
"rebootRequired": true
},
"scheduleJob": {
"entities": [
{
"resource": {
"id": "04e26c5a-2173-4857-98b5-31190bb9985d",
"type": "DEVICE"
}
},
{
"resource": {
"id": "338382d8-d4e3-4573-85fc-27580b68ac5c",
"type": "DEVICE"
}
}
],
"schedule": {
"pattern": {
"frequency": "recurrence",
"repeatFrequency": 2,
"repeatType": "Days",
"type": "daily"
},
"startDate": "2016-04-14T10:10:10+0000"
},
"script": {
"jobType": "missingPatchesDownloadUpdate"
}
}
}
Responses
OK
approvalstring
approvalTypeobject
Child Parameters
- approvalType.approvalReason
- (Optional) Approval reason for executing patches.
- approvalType.approvalType
- Approval type for executing patches. - 0- Manual, 1- Auto
descriptionstring
Description for patch configuration.
enablePatchingboolean
(Optional) Enable patching.
idstring
installationstring
maintenancePeriodinteger
(Optional) Maintenance period for the patches.
patchConfigNamestring
Patch configuration name.
rebootOptionsobject
Child Parameters
- rebootOptions.forceReboot
- Force reboot after execution of patches.
- rebootOptions.rebootRequired
- Reboot required after execution of patches.
scheduleJobobject
Child Parameters
- scheduleJob.client
- scheduleJob.entities
- Resources in which the patches are executed.
- scheduleJob.name
- scheduleJob.schedule
- (Optional sub-fields) Schedule settings.
- scheduleJob.script
sourcestring
{
"approvalType": {
"approvalReason": "testing data",
"approvalType": 1
},
"description": "testing",
"enablePatching": true,
"id": "PATCHCONF-9db1451f-1441-4bd9-90b9-aa371fc11e6d",
"maintenancePeriod": 60,
"patchConfigName": "test",
"rebootOptions": {
"forceReboot": true,
"rebootRequired": true
},
"scheduleJob": {
"client": {
"activated": true,
"id": 13,
"name": "patch client",
"uniqueId": "client_13"
},
"entities": [
{
"resource": {
"clientUniqueId": "client_13",
"generalInfo": {
"hostName": "opsramp-demo-ubuntu-2",
"ipAddresses": "10.21.0.212"
},
"id": "04e26c5a-2173-4857-98b5-31190bb9985d",
"type": "DEVICE"
}
},
{
"resource": {
"clientUniqueId": "client_13",
"generalInfo": {
"hostName": "opsramp-demo-ubuntu-3",
"ipAddresses": "10.21.0.213"
},
"id": "338382d8-d4e3-4573-85fc-27580b68ac5c",
"type": "DEVICE"
}
}
],
"name": "test",
"schedule": {
"pattern": {
"frequency": "recurrence",
"repeatFrequency": 2,
"repeatType": "days",
"type": "daily"
},
"startDate": "2016-04-14T10:10:00+0000"
},
"script": {
"jobType": "missingPatchesDownloadUpdate"
}
}
}