Manage Scheduled Maintenance Windows

Updates, gets and deletes client's scheduled maintenence windows.

Gets scheduled maintenance window details.

Path Parameters

  • clientIdstringrequired

    Describes the clientId of the tenant

  • smIdstringrequired

Responses

  • idstring

  • uniqueIdstring

  • namestringrequired

  • descriptionstringrequired

  • installPatchboolean

  • dontInstallPatchstring

  • runRBAboolean

  • dontRunRBAstring

  • runEscalateActionboolean

  • correlateAlertsboolean

    Enable correlation during maintainence

  • scheduleobjectrequired

  • deviceGroupsarray

  • locationsarray

  • alertConditionsobject

  • statusstring

    Enum:
    CompletedActivePendingSuspended

    Default: Active

  • createdTimestring

  • updatedTimestring

  • createdBynumber

  • updatedBynumber

  • policyUniqueIdstring

  • devicesarrayrequired

Response Samples

{
  "id": "1",
  "uniqueId": "SM-12cf031e-ef33-4318-9707-e3f86817f562",
  "name": "Sample SM",
  "description": "Test Schedule",
  "dontRunRBA": "false",
  "dontInstallPatch": "true",
  "runRBA": true,
  "installPatch": false,
  "runEscalateAction": true,
  "correlateAlerts": true,
  "createdTime": "2021-07-25T03:12:02+0000",
  "updatedTime": "",
  "schedule": {
    "type": "recurring",
    "startTime": "2021-10-01T06:00:00+0530",
    "endTime": "2021-10-01T12:00:00+0530",
    "endBy": "Never",
    "pattern": {
      "type": "monthly",
      "weekIndex": "Second",
      "dayOfWeek": "Wednesday"
    },
    "timezone": "Asia/Calcutta"
  },
  "devices": [
    {
      "id": "4b93211e-776e-4555-811d-ef8a1f300ca0",
      "generalInfo": {
        "name": "vjp02-kailash-sjc",
        "osName": "Linux",
        "ipAddresses": "172.26.22.95",
        "hostName": "vjp02-kailash-sjc",
        "resourceType": "Linux",
        "resourceName": "",
        "aliasName": ""
      },
      "clientUniqueId": "client_13598",
      "type": "DEVICE"
    },
    {
      "id": "cf98748d-bad9-4469-b21d-db3d521720b3",
      "generalInfo": {
        "name": "vjp03-kailash-sjc",
        "osName": "Linux",
        "ipAddresses": "172.26.22.96",
        "hostName": "vjp03-kailash-sjc",
        "resourceType": "Linux",
        "resourceName": "",
        "aliasName": ""
      },
      "clientUniqueId": "client_13598",
      "type": "DEVICE"
    }
  ],
  "status": "Pending"
}

Updates a pending schedule maintenance window.

Notes

  • Schedule details can be updated. For example: name, schedule type, and alert conditions. Resource details cannot be updated.
  • To get the list of pending schedule maintenance windows, use the Search Schedule Maintenance Windows endpoint.
  • For a recurring schedule maintenance to end at a specific time period, provide the end date and time in the field endTime. Example: "2016-05-29T18:55:27+0000"

Path Parameters

  • clientIdstringrequired

    Describes the clientId of the tenant

  • smIdstringrequired

Request Body

application/json

  • uniqueIdstring

  • namestringrequired

  • descriptionstringrequired

  • installPatchboolean

  • dontInstallPatchstring

  • runRBAboolean

  • runEscalateActionboolean

  • correlateAlertsboolean

    Enable correlation during maintainence

  • scheduleobjectrequired

  • dontRunRBAstring

  • alertConditionsobject

Request Body Samples

{
  "name": "Network devices schedule maintenance",
  "description": "Recurring maintenance",
  "runRBA": false,
  "installPatch": false,
  "correlateAlerts": true,
  "schedule": {
    "type": "Recurring",
    "startTime": "2018-08-18T10:55:27+0000",
    "endTime": "2018-08-19T18:55:27+0000",
    "timezone": "GMT",
    "pattern": {
      "type": "weekly",
      "weekDays": "Wednesday,Thursday"
    }
  },
  "alertConditions": {
    "matchingType": "ANY",
    "rules": [
      {
        "key": "subject",
        "operator": "CONTAINS",
        "value": "newTest"
      },
      {
        "key": "description",
        "operator": "CONTAINS",
        "value": "test Description"
      },
      {
        "key": "serviceName",
        "operator": "CONTAINS",
        "value": "newTest"
      }
    ]
  }
}

Responses

  • uniqueIdstring

Response Samples

{
  "uniqueId": "SM-c11b6b44-c85a-426c-9963-0e977070ce98"
}

Deletes a scheduled maintenance window.

Path Parameters

  • clientIdstringrequired

    Describes the clientId of the tenant

  • smIdstringrequired

Responses

200OK