Endpoint
/api/v2/tenants/{tenantId}/patches/configurations
Path Parameters
tenantId
string

Describes the clientId of the tenant

approval
string

approvalType
object

approvalType.approvalReason
Approval reason for executing patches.
approvalType.approvalType
Approval type for executing patches. - 0- Manual, 1- Auto
description
string

Description for patch configuration.

enablePatching
boolean

Enable patching.

id
string

installation
string

maintenancePeriod
integer

Maintenance period for the patches.

patchConfigName
string

Patch configuration name.

rebootOptions
object

rebootOptions.forceReboot
Force reboot after execution of patches.
rebootOptions.rebootRequired
Reboot required after execution of patches.
scheduleJob
object

scheduleJob.client
scheduleJob.entities
Resources in which the patches are executed.
scheduleJob.name
scheduleJob.schedule
(Optional sub-fields) Schedule settings.
scheduleJob.script
source
string

{
  "approvalType": {
    "approvalReason": "testing data",
    "approvalType": 1
  },
  "description": "testing",
  "enablePatching": true,
  "maintenancePeriod": 60,
  "patchConfigName": "Test_Patch_Config",
  "rebootOptions": {
    "forceReboot": true,
    "rebootRequired": true
  },
  "scheduleJob": {
    "entities": [
      {
        "resource": {
          "id": "04e26c5a-2173-4857-98b5-31190bb9985d",
          "type": "DEVICE"
        }
      },
      {
        "resource": {
          "id": "338382d8-d4e3-4573-85fc-27580b68ac5c",
          "type": "DEVICE"
        }
      }
    ],
    "schedule": {
      "pattern": {
        "frequency": "recurrence",
        "repeatFrequency": 2,
        "repeatType": "Days",
        "type": "daily"
      },
      "startDate": "2016-04-14T10:10:10+0000"
    },
    "script": {
      "jobType": "missingPatchesDownloadUpdate"
    }
  }
}

Responses

OK

approval
string

approvalType
object

approvalType.approvalReason
Approval reason for executing patches.
approvalType.approvalType
Approval type for executing patches. - 0- Manual, 1- Auto
description
string

Description for patch configuration.

enablePatching
boolean

Enable patching.

id
string

installation
string

maintenancePeriod
integer

Maintenance period for the patches.

patchConfigName
string

Patch configuration name.

rebootOptions
object

rebootOptions.forceReboot
Force reboot after execution of patches.
rebootOptions.rebootRequired
Reboot required after execution of patches.
scheduleJob
object

scheduleJob.client
scheduleJob.entities
Resources in which the patches are executed.
scheduleJob.name
scheduleJob.schedule
(Optional sub-fields) Schedule settings.
scheduleJob.script
source
string

{
  "approvalType": {
    "approvalReason": "testing data",
    "approvalType": 1
  },
  "description": "testing",
  "enablePatching": true,
  "id": "PATCHCONF-9db1451f-1441-4bd9-90b9-aa371fc11e6d",
  "maintenancePeriod": 60,
  "patchConfigName": "test",
  "rebootOptions": {
    "forceReboot": true,
    "rebootRequired": true
  },
  "scheduleJob": {
    "client": {
      "activated": true,
      "id": 13,
      "name": "patch client",
      "uniqueId": "client_13"
    },
    "entities": [
      {
        "resource": {
          "clientUniqueId": "client_13",
          "generalInfo": {
            "hostName": "opsramp-demo-ubuntu-2",
            "ipAddresses": "10.21.0.212"
          },
          "id": "04e26c5a-2173-4857-98b5-31190bb9985d",
          "type": "DEVICE"
        }
      },
      {
        "resource": {
          "clientUniqueId": "client_13",
          "generalInfo": {
            "hostName": "opsramp-demo-ubuntu-3",
            "ipAddresses": "10.21.0.213"
          },
          "id": "338382d8-d4e3-4573-85fc-27580b68ac5c",
          "type": "DEVICE"
        }
      }
    ],
    "name": "test",
    "schedule": {
      "pattern": {
        "frequency": "recurrence",
        "repeatFrequency": 2,
        "repeatType": "days",
        "type": "daily"
      },
      "startDate": "2016-04-14T10:10:00+0000"
    },
    "script": {
      "jobType": "missingPatchesDownloadUpdate"
    }
  }
}