Endpoint
/api/v2/tenants/{tenantId}/patches/compliance
Gets the list of patch compliance checks.
Path Parameters
tenantIdstring
Query Parameters
pageNointeger
pageSizeinteger
isDescendingOrderboolean
sortNamestring
Responses
OK
descendingOrderboolean
nextPageboolean
orderBystring
pageNointeger
pageSizeinteger
previousPageNointeger
resultsarray
Child Parameters
- results.createdTime
- results.createdUser
- results.description
- (Optional) Description for patch compliance.
- results.id
- results.name
- Unique name for patch compliance.
- results.osType
- Patches of a certain OS (operating system). Supported values: WINDOWS, LINUX
- results.updatedTime
- results.updatedUser
totalPagesinteger
totalResultsinteger
{
"descendingOrder": true,
"nextPage": false,
"orderBy": "name",
"pageNo": 1,
"pageSize": 100,
"previousPageNo": 0,
"results": [
{
"createdTime": "2019-01-29T12:47:07+0000",
"createdUser": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
},
"description": "Compliance check for Windows Device Group-3",
"id": "PCMP-9393677c-e3f4-4df0-89c5-17c648268e65",
"name": "Compliance for Windows Device Group-3",
"osType": "WINDOWS",
"updatedTime": "2019-01-29T12:48:07+0000",
"updatedUser": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
}
},
{
"createdTime": "2019-01-29T07:53:28+0000",
"createdUser": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
},
"description": "Compliance check for Windows Device Group-2",
"id": "PCMP-4ea84abe-acb1-427a-ad90-a23dc34a3953",
"name": "Compliance for Windows Device Group-2",
"osType": "WINDOWS",
"updatedTime": "2019-01-30T10:20:10+0000",
"updatedUser": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
}
},
{
"createdTime": "2019-01-26T10:48:04+0000",
"createdUser": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
},
"description": "Patch Compliance for specific Windows Device Group-1",
"id": "PCMP-2ec8e6e1-38c0-466f-b82e-8c242a13ee4e",
"name": "Compliance for Windows Device Group-1",
"osType": "WINDOWS",
"updatedTime": "2019-01-30T11:30:20+0000",
"updatedUser": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
}
},
{
"createdTime": "2019-01-26T10:25:26+0000",
"createdUser": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
},
"description": "Compliance check for Windows Devices",
"id": "PCMP-0e14f0bd-8f7d-49a5-bd84-d28267444971",
"name": "Compliance for Windows Devices",
"osType": "WINDOWS",
"updatedTime": "2019-01-29T04:55:05+0000",
"updatedUser": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith",
"phoneNumber": ""
}
},
{
"createdTime": "2019-01-26T08:43:52+0000",
"createdUser": {
"email": "james.blake@myorganization.com",
"firstName": "James",
"lastName": "Blake",
"loginName": "James.Blake",
"phoneNumber": ""
},
"description": "Patch Compliance for Linux Devices",
"id": "PCMP-9c7ff57d-fe04-4d89-aebe-f8c8958d7677",
"name": "Compliance for Linux Devices",
"osType": "LINUX",
"updatedTime": "2019-01-27T10:40:20+0000",
"updatedUser": {
"email": "james.blake@myorganization.com",
"firstName": "James",
"lastName": "Blake",
"loginName": "James.Blake",
"phoneNumber": ""
}
},
{
"createdTime": "2019-01-26T10:38:45+0000",
"createdUser": {
"email": "james.blake@myorganization.com",
"firstName": "James",
"lastName": "Blake",
"loginName": "James.Blake"
},
"description": "Compliance check for Linux Device Group-1",
"id": "PCMP-f3ea1402-1186-41ef-9069-c47de1075771",
"name": "Compliance for Linux Device Group-1",
"osType": "LINUX",
"updatedTime": "2019-01-29T05:06:09+0000",
"updatedUser": {
"email": "james.blake@myorganization.com",
"firstName": "James",
"lastName": "Blake",
"loginName": "James.Blake",
"phoneNumber": ""
}
}
],
"totalPages": 1,
"totalResults": 6
}
Endpoint
/api/v2/tenants/{tenantId}/patches/compliance
Creates a patch compliance.
Path Parameters
tenantIdstring
createdTimestring
createdUserobject
Child Parameters
- createdUser.email
- createdUser.firstName
- createdUser.lastName
- createdUser.loginName
descriptionstring
(Optional) Description for patch compliance.
idstring
namestring
Unique name for patch compliance.
osTypestring
Patches of a certain OS (operating system). Supported values: WINDOWS, LINUX
updatedTimestring
updatedUserobject
Child Parameters
- updatedUser.email
- updatedUser.firstName
- updatedUser.lastName
- updatedUser.loginName
{
"description": "Compliance Check for Certain Windows Devices",
"name": "Patch Compliance of Windows Devices",
"osType": "WINDOWS"
}
Responses
OK
createdTimestring
createdUserobject
Child Parameters
- createdUser.email
- createdUser.firstName
- createdUser.lastName
- createdUser.loginName
descriptionstring
(Optional) Description for patch compliance.
idstring
namestring
Unique name for patch compliance.
osTypestring
Patches of a certain OS (operating system). Supported values: WINDOWS, LINUX
updatedTimestring
updatedUserobject
Child Parameters
- updatedUser.email
- updatedUser.firstName
- updatedUser.lastName
- updatedUser.loginName
{
"createdTime": "2019-02-08T12:37:02+0000",
"createdUser": {
"email": "admin@opsramp.com",
"firstName": "OpsRamp API User",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"description": "Compliance check for Certain Windows Devices",
"id": "PCMP-5c70ea87-2350-4781-9762-df47194d06d3",
"name": "Patch Compliance of Windows Devices",
"osType": "WINDOWS",
"updatedTime": "2019-02-10T10:40:05+0000",
"updatedUser": {
"email": "admin@opsramp.com",
"firstName": "OpsRamp API User",
"lastName": " ",
"loginName": "opsramp_api_user"
}
}