Get patch compliance

This endpoint is used to retrieve the list of patch compliance checks.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{clientId}/patches/compliance

Sample URLs

To retrieve the list of patch compliance checks:

https://{api-url}/api/v2/tenants/client_16/patches/compliance

To retrieve the list of patch compliance checks with pagination:

https://{api-url}/api/v2/tenants/client_16/patches/compliance?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=name

Parameters

All parameters are optional:

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}name

Sample response

{
	"results": [{
			"id": "PCMP-9393677c-e3f4-4df0-89c5-17c648268e65",
			"name": "Compliance for Windows Device Group-3",
			"description": "Compliance check for Windows Device Group-3",
			"createdUser": {
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@myorganization.com"
			},
			"updatedUser": {
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@myorganization.com"
			},
			"createdTime": "2019-01-29T12:47:07+0000",
			"updatedTime": "2019-01-29T12:48:07+0000",
			"osType": "WINDOWS"
		},
		{
			"id": "PCMP-4ea84abe-acb1-427a-ad90-a23dc34a3953",
			"name": "Compliance for Windows Device Group-2",
			"description": "Compliance check for Windows Device Group-2",
			"createdUser": {
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@myorganization.com"
			},
			"updatedUser": {
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@myorganization.com"
			},
			"createdTime": "2019-01-29T07:53:28+0000",
			"updatedTime": "2019-01-30T10:20:10+0000",
			"osType": "WINDOWS"
		},
		{
			"id": "PCMP-2ec8e6e1-38c0-466f-b82e-8c242a13ee4e",
			"name": "Compliance for Windows Device Group-1",
			"description": "Patch Compliance for specific Windows Device Group-1",
			"createdUser": {
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@myorganization.com"
			},
			"updatedUser": {
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@myorganization.com"
			},
			"createdTime": "2019-01-26T10:48:04+0000",
			"updatedTime": "2019-01-30T11:30:20+0000",
			"osType": "WINDOWS"
		},
		{
			"id": "PCMP-0e14f0bd-8f7d-49a5-bd84-d28267444971",
			"name": "Compliance for Windows Devices",
			"description": "Compliance check for Windows Devices",
			"createdUser": {
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@myorganization.com"
			},
			"updatedUser": {
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@myorganization.com",
				"phoneNumber": ""
			},
			"createdTime": "2019-01-26T10:25:26+0000",
			"updatedTime": "2019-01-29T04:55:05+0000",
			"osType": "WINDOWS"
		},
		{
			"id": "PCMP-9c7ff57d-fe04-4d89-aebe-f8c8958d7677",
			"name": "Compliance for Linux Devices",
			"description": "Patch Compliance for Linux Devices",
			"createdUser": {
				"loginName": "James.Blake",
				"lastName": "Blake",
				"firstName": "James",
				"email": "james.blake@myorganization.com",
				"phoneNumber": ""
			},
			"updatedUser": {
				"loginName": "James.Blake",
				"lastName": "Blake",
				"firstName": "James",
				"email": "james.blake@myorganization.com",
				"phoneNumber": ""
			},
			"createdTime": "2019-01-26T08:43:52+0000",
			"updatedTime": "2019-01-27T10:40:20+0000",
			"osType": "LINUX"
		},
		{
			"id": "PCMP-f3ea1402-1186-41ef-9069-c47de1075771",
			"name": "Compliance for Linux Device Group-1",
			"description": "Compliance check for Linux Device Group-1",
			"createdUser": {
				"loginName": "James.Blake",
				"lastName": "Blake",
				"firstName": "James",
				"email": "james.blake@myorganization.com"
			},
			"updatedUser": {
				"loginName": "James.Blake",
				"lastName": "Blake",
				"firstName": "James",
				"email": "james.blake@myorganization.com",
				"phoneNumber": ""
			},
			"createdTime": "2019-01-26T10:38:45+0000",
			"updatedTime": "2019-01-29T05:06:09+0000",
			"osType": "LINUX"
		}
	],
	"totalResults": 6,
	"orderBy": "name",
	"pageNo": 1,
	"pageSize": 100,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": true
}