Get, update, and delete patch baselines

/api/v2/tenants/{tenantId}/patches/baselines/{baselineId}

Deletes a patch baseline.

Path Parameters

tenantId
string

baselineId
string

/api/v2/tenants/{tenantId}/patches/baselines/{baselineId}

Gets the list of patches in a patch baseline.

Notes

There are special characters that can be used in a query string:

(+) represents the next field and must be URL-encoded.
(:) represents equals. An example is key : value.
Space characters must be URL-encoded.

Path Parameters

tenantId
string

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

Child Parameters

results.category
results.externalId
results.id
results.name
results.rating
results.rebootRequired
results.releaseTime
results.severity
results.type

totalPages
integer

totalResults
integer

{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "name",
  "pageNo": 1,
  "pageSize": 100,
  "previousPageNo": 0,
  "results": [
    {
      "category": "Updates - Windows 7",
      "externalId": "3184143",
      "id": "PATCH-be4069ba-f432-4a02-b861-fbd826890cb3",
      "name": "Update for Windows 7 (KB3184143)",
      "rating": {
        "rating": "TESTING"
      },
      "rebootRequired": true,
      "releaseTime": "2016-10-11T00:00:00+0000",
      "severity": "Important",
      "type": "WINDOWS"
    },
    {
      "category": "Updates - Windows 7",
      "externalId": "3179573",
      "id": "PATCH-d119f423-9b5f-4685-9145-85a011ddc29d",
      "name": "Update for Windows 7 (KB3179573)",
      "rating": {
        "rating": "TESTING"
      },
      "rebootRequired": true,
      "releaseTime": "2016-09-13T00:00:00+0000",
      "severity": "Important",
      "type": "WINDOWS"
    },
    {
      "category": "Updates - Windows 7",
      "externalId": "3170735",
      "id": "PATCH-3a011c95-a03f-4a35-93f1-75f6e1fe6d63",
      "name": "Update for Windows 7 (KB3170735)",
      "rating": {
        "rating": "TESTING"
      },
      "rebootRequired": true,
      "releaseTime": "2016-07-12T00:00:00+0000",
      "severity": "Important",
      "type": "WINDOWS"
    },
    {
      "category": "Updates - Windows 7",
      "externalId": "3161102",
      "id": "PATCH-f0a474bc-008c-4569-aff9-9b1aa5134a65",
      "name": "Update for Windows 7 (KB3161102)",
      "rating": {
        "rating": "TESTING"
      },
      "rebootRequired": true,
      "releaseTime": "2016-09-13T00:00:00+0000",
      "severity": "Important",
      "type": "WINDOWS"
    },
    {
      "category": "Updates - Windows 7",
      "externalId": "3147071",
      "id": "PATCH-1ee57411-43da-42da-80db-3e26cbdf52cf",
      "name": "Update for Windows 7 (KB3147071)",
      "rating": {
        "rating": "TESTING"
      },
      "rebootRequired": true,
      "releaseTime": "2016-04-12T00:00:00+0000",
      "severity": "Important",
      "type": "WINDOWS"
    },
    {
      "category": "Updates - Windows 7",
      "externalId": "3138378",
      "id": "PATCH-a90ed74a-8283-4368-8dd2-51f982ffe082",
      "name": "Update for Windows 7 (KB3138378)",
      "rating": {
        "rating": "TESTING"
      },
      "rebootRequired": true,
      "releaseTime": "2016-05-10T00:00:00+0000",
      "severity": "Important",
      "type": "WINDOWS"
    },
    {
      "category": "Updates - Windows 7",
      "externalId": "3137061",
      "id": "PATCH-f9b5f8dd-f7ca-4a42-9558-34db7913ce39",
      "name": "Update for Windows 7 (KB3137061)",
      "rating": {
        "rating": "TESTING"
      },
      "rebootRequired": true,
      "releaseTime": "2016-04-12T00:00:00+0000",
      "severity": "Important",
      "type": "WINDOWS"
    },
    {
      "category": "Updates - Windows 7",
      "externalId": "3133977",
      "id": "PATCH-e4a948bc-4274-4cbc-9f1d-8a3d22415630",
      "name": "Update for Windows 7 (KB3133977)",
      "rating": {
        "rating": "TESTING"
      },
      "rebootRequired": true,
      "releaseTime": "2016-04-12T00:00:00+0000",
      "severity": "Important",
      "type": "WINDOWS"
    },
    {
      "category": "Updates - Windows 7",
      "externalId": "3102429",
      "id": "PATCH-5cc371f8-b82c-4aa8-9bab-ae452c7a75fe",
      "name": "Update for Windows 7 (KB3102429)",
      "rating": {
        "rating": "TESTING"
      },
      "rebootRequired": true,
      "releaseTime": "2016-01-19T00:00:00+0000",
      "severity": "Important",
      "type": "WINDOWS"
    },
    {
      "category": "Updates - Windows 7",
      "externalId": "3080149",
      "id": "PATCH-f178f950-12d4-49a4-be5e-5a8418ceb5bf",
      "name": "Update for Windows 7 (KB3080149)",
      "rating": {
        "rating": "TESTING"
      },
      "rebootRequired": true,
      "releaseTime": "2015-09-08T00:00:00+0000",
      "severity": "Important",
      "type": "WINDOWS"
    }
  ],
  "totalPages": 1,
  "totalResults": 10
}

/api/v2/tenants/{tenantId}/patches/baselines/{baselineId}

Updates patch baseline details.

Path Parameters

tenantId
string

baselineId
string

Request Body
Examples

createdTime
string

createdUser
object

Child Parameters

createdUser.email
createdUser.firstName
createdUser.lastName
createdUser.loginName

description
string

(Optional) Description of a patch baseline.

dynamic
boolean

- Provide "dynamic": false to create a static baseline. - Provide "dynamic": true to create a dynamic baseline.

enabled
boolean

id
string

installedIntg
object

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" }

Child Parameters

installedIntg.displayName
installedIntg.id
installedIntg.integration

name
string

Unique name to identify a patch baseline.

policy
object

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" } ] } ```

Child Parameters

policy.actions
policy.id
policy.matchType
policy.rules
policy.uid

updatedTime
string

updatedUser
object

Child Parameters

updatedUser.email
updatedUser.firstName
updatedUser.lastName
updatedUser.loginName

{
  "description": "Linux_Patches_for_SJ_Devices",
  "dynamic": true,
  "installedIntg": {
    "id": "INTG-35160619-ea2d-4450-8b8d-7c4bc51ebc92"
  },
  "name": "Linux_Patch_Baseline",
  "policy": {
    "matchType": "ALL",
    "rules": [
      {
        "key": "Category",
        "operator": "Contains",
        "value": "Updates"
      },
      {
        "key": "Rating",
        "operator": "Equals",
        "value": "WHITELISTED"
      },
      {
        "key": "Severity",
        "operator": "Not Equals",
        "value": "Critical"
      }
    ]
  }
}

{
  "description": "Windows_Vulnerabilities",
  "dynamic": true,
  "installedIntg": {
    "id": "INTG-c2f39b7b-ad25-11e8-924d-080027f0b4d6"
  },
  "name": "Windows_Patch_Feed"
}

Schema
Example Response

createdTime
string

createdUser
object

Child Parameters

createdUser.email
createdUser.firstName
createdUser.lastName
createdUser.loginName

description
string

(Optional) Description of a patch baseline.

dynamic
boolean

- Provide "dynamic": false to create a static baseline. - Provide "dynamic": true to create a dynamic baseline.

enabled
boolean

id
string

installedIntg
object

Child Parameters

installedIntg.displayName
installedIntg.id
installedIntg.integration

name
string

Unique name to identify a patch baseline.

policy
object

Child Parameters

policy.actions
policy.id
policy.matchType
policy.rules
policy.uid

updatedTime
string

updatedUser
object

Child Parameters

updatedUser.email
updatedUser.firstName
updatedUser.lastName
updatedUser.loginName

{
  "createdTime": "2019-02-08T07:45:10+0000",
  "createdUser": {
    "email": "john.smith@myorganization.com",
    "firstName": "John",
    "lastName": "Smith",
    "loginName": "John.Smith"
  },
  "description": "Linux_Patches_for_SJ_Devices",
  "dynamic": true,
  "enabled": false,
  "id": "PBL-198014e3-74c0-4e12-a6e1-c161d9003fd6",
  "installedIntg": {
    "displayName": "Default Linux Feed",
    "id": "INTG-c2f39b7b-ad25-11e8-924d-080027f0b4d6",
    "integration": {
      "id": "LINUXPATCH",
      "name": "Linux Patch Feed"
    }
  },
  "name": "Linux_Patch_Baseline",
  "policy": {
    "actions": [],
    "id": 663,
    "matchType": "ALL",
    "rules": [
      {
        "id": 12514,
        "key": "Category",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "Updates"
      },
      {
        "id": 12515,
        "key": "Rating",
        "operator": "Equals",
        "resourceType": "DEVICE",
        "value": "WHITELISTED"
      },
      {
        "id": 12516,
        "key": "Severity",
        "operator": "Not Equals",
        "resourceType": "DEVICE",
        "value": "Critical"
      }
    ],
    "uid": "POLICY-1308aebb-94a8-4bde-aed9-1dd4aafe78a8"
  },
  "updatedTime": "2019-02-08T09:18:21+0000",
  "updatedUser": {
    "email": "john.smith@myorganization.com",
    "firstName": "John",
    "lastName": "Smith",
    "loginName": "John.Smith"
  }
}

{
  "createdTime": "2019-02-08T07:40:06+0000",
  "createdUser": {
    "email": "john.smith@myorganization.com",
    "firstName": "John",
    "lastName": "Smith",
    "loginName": "John.Smith"
  },
  "description": "Windows_Vulnerabilities",
  "dynamic": false,
  "enabled": false,
  "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_Patch_Feed",
  "updatedTime": "2019-02-08T09:11:19+0000",
  "updatedUser": {
    "email": "john.smith@myorganization.com",
    "firstName": "John",
    "lastName": "Smith",
    "loginName": "John.Smith"
  }
}

Endpoint

Path Parameters

tenantIdstring

baselineIdstring

Responses

Endpoint

Notes

Path Parameters

tenantIdstring

baselineIdstring

Responses

descendingOrderboolean

nextPageboolean

orderBystring

pageNointeger

pageSizeinteger

previousPageNointeger

resultsarray

totalPagesinteger

totalResultsinteger

Endpoint

Path Parameters

tenantIdstring

baselineIdstring

createdTimestring

createdUserobject

descriptionstring

dynamicboolean

enabledboolean

idstring

installedIntgobject

namestring

policyobject

updatedTimestring

updatedUserobject

Responses

createdTimestring

createdUserobject

descriptionstring

dynamicboolean

enabledboolean

idstring

installedIntgobject

namestring

policyobject

updatedTimestring

updatedUserobject

tenantId
string

baselineId
string

tenantId
string

baselineId
string

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

totalPages
integer

totalResults
integer

tenantId
string

baselineId
string

createdTime
string

createdUser
object

description
string

dynamic
boolean

enabled
boolean

id
string

installedIntg
object

name
string

policy
object

updatedTime
string

updatedUser
object

createdTime
string

createdUser
object

description
string

dynamic
boolean

enabled
boolean

id
string

installedIntg
object

name
string

policy
object

updatedTime
string

updatedUser
object