Endpoint
/api/v2/tenants/{tenantId}/patches/compliance/{complianceId}/baselines
Path Parameters
tenantId
string

Describes the clientId of the tenant

complianceId
string

Unique Identifier (UUID) of the compliance

Query Parameters
pageNo
integer

pageSize
integer

isDescendingOrder
boolean

sortName
string

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.createdTime
results.createdUser
results.description
(Optional) Description of a patch baseline.
results.dynamic
- Provide "dynamic": false to create a static baseline. - Provide "dynamic": true to create a dynamic baseline.
results.enabled
results.id
results.installedIntg
ID of an installed patch feed integration. Example: INTG-c1a2d041-062d-4950-8570-f9d5a4dc0c34To fetch ID of an installed patch feed integration: 1. Log into OpsRamp. 2. Click All Clients and then select the required client. 3. On the drop-down menu, click Setup. 4. On the left-hand side panel, click Integrations, click Available Integrations and click on an installed patch feed integration. 5. Copy the UID. 6. Paste the UID in the id field of the request payload. Example: "installedIntg": { "id": "INTG-c2f39b7b-ad25-11e8-924d-080027f0b4d6" }
results.name
Unique name to identify a patch baseline.
results.policy
Filter criteria for dynamic baseline: - Match type for the rules. Supported value: ALLPatches which match all the rules in the filter criteria are added to the baseline. - Filter patches with the following rules: - key: Provide the attributes of a patch. - Supported keys: Category, Cve, Rating, Severity Below table provides the list of supported operators and values for the keys. |Key|Operator|Value| |-----|-----|-----| |Category|Contains, Not Contains, Equals, Not Equals, Starts with, Ends with|NA| |Cve|Contains, Not Contains, Equals, Not Equals, Starts with, Ends with|NA| |Rating|Equals, Not Equals|Whitelisted, Blacklisted| |Severity|Contains, Not Contains, Equals, Not Equals, Starts with, Ends with|NA| For example, to filter patches which are whitelisted and are critical, provide the fields as shown below: ``` "policy": { "matchType": "ALL", "rules": [ { "key": "Rating", "operator": "Equals", "value": "Whitelisted" }, { "key": "Severity", "operator": "Contains", "value": "critical" } ] } ```
results.updatedTime
results.updatedUser
totalPages
integer

totalResults
integer

{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "name",
  "pageNo": 1,
  "pageSize": 10,
  "previousPageNo": 0,
  "results": [
    {
      "createdTime": "2019-02-08T07:40:06+0000",
      "createdUser": {
        "email": "john.smith@myorganization.com",
        "firstName": "John",
        "lastName": "Smith",
        "loginName": "John.Smith"
      },
      "description": "This baseline includes patches approved for Windows device",
      "dynamic": false,
      "enabled": true,
      "id": "PBL-bafd3744-9a59-4cd6-9825-00a0a5a54f6e",
      "installedIntg": {
        "displayName": "Default Windows Feed",
        "id": "INTG-c2f39b7b-ad25-11e8-924d-080027f0b4d6",
        "integration": {
          "id": "WINDOWSPATCH",
          "name": "Windows Patch Feed"
        }
      },
      "name": "Windows-DefaultPatchBaseline",
      "updatedTime": "2019-02-10T09:54:17+0000",
      "updatedUser": {
        "email": "john.smith@myorganization.com",
        "firstName": "John",
        "lastName": "Smith",
        "loginName": "John.Smith"
      }
    },
    {
      "createdTime": "2019-01-23T09:41:12+0000",
      "createdUser": {
        "email": "james.blake@myorganization.com",
        "firstName": "James",
        "lastName": "Blake",
        "loginName": "James.Blake"
      },
      "description": "This baseline includes patches approved for Linux device",
      "dynamic": false,
      "enabled": true,
      "id": "PBL-63c75c7b-bee0-41f5-816b-e241f8753472",
      "installedIntg": {
        "displayName": "Default Linux Feed",
        "id": "INTG-c2f39b7b-ad25-11e8-924d-080027f0b4d6",
        "integration": {
          "id": "LINUXPATCH",
          "name": "Linux Patch Feed"
        }
      },
      "name": "Linux-DefaultPatchBaseline",
      "updatedTime": "2019-01-24T06:08:07+0000",
      "updatedUser": {
        "email": "james.blake@myorganization.com",
        "firstName": "James",
        "lastName": "Blake",
        "loginName": "James.Blake",
        "phoneNumber": ""
      }
    },
    {
      "createdTime": "2019-01-23T09:39:13+0000",
      "createdUser": {
        "email": "john.smith@myorganization.com",
        "firstName": "John",
        "lastName": "Smith",
        "loginName": "John.Smith"
      },
      "description": "This baseline includes all critical Windows patches",
      "dynamic": false,
      "enabled": true,
      "id": "PBL-c8622232-5dcc-4dba-9426-882e7205b065",
      "installedIntg": {
        "displayName": "Default Windows Feed",
        "id": "INTG-c2f39b7b-ad25-11e8-924d-080027f0b4d6",
        "integration": {
          "id": "WINDOWSPATCH",
          "name": "Windows Patch Feed"
        }
      },
      "name": "Critical Windows Patch Baseline",
      "updatedTime": "2019-01-24T08:48:11+0000",
      "updatedUser": {
        "email": "john.smith@myorganization.com",
        "firstName": "John",
        "lastName": "Smith",
        "loginName": "John.Smith",
        "phoneNumber": ""
      }
    },
    {
      "createdTime": "2019-02-08T07:45:10+0000",
      "createdUser": {
        "email": "james.blake@myorganization.com",
        "firstName": "James",
        "lastName": "Blake",
        "loginName": "James.Blake"
      },
      "description": "This baseline includes Linux operating system security patches",
      "dynamic": true,
      "enabled": true,
      "id": "PBL-198014e3-74c0-4e12-a6e1-c161d9003fd6",
      "installedIntg": {
        "displayName": "Default Windows Feed",
        "id": "INTG-c2f39b7b-ad25-11e8-924d-080027f0b4d6",
        "integration": {
          "id": "WINDOWSPATCH",
          "name": "Windows Patch Feed"
        }
      },
      "name": "Critical Linux Patch Baseline",
      "policy": {
        "actions": [],
        "id": 663,
        "matchType": "ALL",
        "rules": [
          {
            "id": 12514,
            "key": "Category",
            "operator": "Contains",
            "resourceType": "DEVICE",
            "value": "Security Updates"
          },
          {
            "id": 12515,
            "key": "Rating",
            "operator": "Equals",
            "resourceType": "DEVICE",
            "value": "BLACKLISTED"
          },
          {
            "id": 12516,
            "key": "Severity",
            "operator": "Not Equals",
            "resourceType": "DEVICE",
            "value": "Critical"
          }
        ],
        "uid": "POLICY-1308aebb-94a8-4bde-aed9-1dd4aafe78a8"
      },
      "updatedTime": "2019-02-08T09:18:22+0000",
      "updatedUser": {
        "email": "james.blake@myorganization.com",
        "firstName": "James",
        "lastName": "Blake",
        "loginName": "James.Blake"
      }
    }
  ],
  "totalPages": 1,
  "totalResults": 4
}