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

Loading Examples...

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

Loading Examples...

Responses

  • uniqueIdstring

Loading Examples...

Deletes a scheduled maintenance window.

Path Parameters

  • clientIdstringrequired

    Describes the clientId of the tenant

  • smIdstringrequired

Responses

200OK