Search patch configuration

This endpoint is used to search for patch configurations by a client.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/patches/configurations/search

Sample URLs

https://{api-url}/api/v2/tenants/client_93/patches/configurations/search

Parameters

All parameters are optional:

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}job.id

Sample response

{
	"results": [{
			"scheduleJob": {
				"name": "Test",
				"schedule": {
					"startDate": "2017-02-10T00:00:00+0000",
					"pattern": {
						"type": "daily",
						"frequency": "everyday"
					}
				},
				"client": {
					"id": 13,
					"uniqueId": "client_13",
					"name": "patch client",
					"activated": true
				},
				"script": {
					"jobType": "missingPatchesDownloadUpdate"
				}
			},
			"id": "PATCHCONF-5ec1d773-8082-417c-9461-279e74a1247e",
			"patchConfigName": "Update",
			"description": "Update Antivirus",
			"approvalType": {
				"approvalType": 0,
				"approvalReason": ""
			},
			"rebootOptions": {
				"rebootRequired": false,
				"forceReboot": false
			},
			"enablePatching": true,
			"maintenancePeriod": 30
		},
		{
			"scheduleJob": {
				"name": "test",
				"schedule": {
					"startDate": "2016-04-14T10:10:00+0000",
					"pattern": {
						"type": "daily",
						"frequency": "recurrence",
						"repeatFrequency": 2,
						"repeatType": "days"
					}
				},
				"client": {
					"id": 13,
					"uniqueId": "client_13",
					"name": "patch client",
					"activated": true
				},
				"script": {
					"jobType": "missingPatchesDownloadUpdate"
				}
			},
			"id": "PATCHCONF-9db1451f-1441-4bd9-90b9-aa371fc11e6d",
			"patchConfigName": "test",
			"description": "testing",
			"approvalType": {
				"approvalType": 1,
				"approvalReason": "testing data"
			},
			"rebootOptions": {
				"rebootRequired": true,
				"forceReboot": true
			},
			"enablePatching": true,
			"maintenancePeriod": 60
		}
	],
	"totalResults": 2,
	"orderBy": "patch.patchConfigName",
	"pageNo": 1,
	"pageSize": 10,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": true
}