Endpoint
/api/v2/tenants/{tenantId}/scheduleMaintenances
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

alertConditions
object

alertConditions.matchingType
alertConditions.policyUniqueId
alertConditions.rules
description
string

deviceGroups
array

deviceGroups.name
devices
array

devices.hostName
dontInstallPatch
boolean

dontRunRBA
string

installPatch
boolean

locations
array

locations.name
name
string

runEscalateAction
boolean

runRBA
boolean

schedule
object

Describes the Scheduling time period and recurring pattern of the Scheduled Maintainence Windows

schedule.endTime
UTC/GMT time or time with timezone offset Eg:"2021-09-09T19:00:00+0000" for GMT/UTC time or "2021-09-09T13:00:00-0600" for America/Denver timezone
schedule.pattern
Recurring pattern details.
schedule.startTime
UTC/GMT time or time with timezone offset Eg:"2021-09-09T19:00:00+0000" for GMT/UTC time or "2021-09-09T13:00:00-0600" for America/Denver timezone
schedule.timezone
Timezone for which the user wants to set as Local time.For eg "timezone": "America/Denver will let the users get the local time in America/Denver Timezone.
schedule.type
Schedule maintainence recurrence type : One-time,Recurring
uniqueId
string

{
  "description": "Recurring-dailyeverydayschedule",
  "deviceGroups": [
    {
      "name": "DG-1"
    },
    {
      "id": "11"
    }
  ],
  "devices": [
    {
      "hostName": "Device_1"
    },
    {
      "uniqueId": "90491678-096c-4223-9867-f31c37ff09da"
    }
  ],
  "installPatch": false,
  "locations": [
    {
      "name": "LOC-1"
    },
    {
      "id": "12"
    }
  ],
  "name": "Recurring-dailyeverydayschedule",
  "runRBA": false,
  "schedule": {
    "endTime": "2015-05-29T18:55:27+0000",
    "pattern": {
      "dayFrequency": "every weekday",
      "type": "daily"
    },
    "startTime": "2015-05-28T10:55:27+0000",
    "timezone": "America/Puerto_Rico",
    "type": "Recurring"
  }
}
{
  "description": "Recurring-monthly-1schedule",
  "deviceGroups": [
    {
      "name": "DG-1"
    },
    {
      "id": "11"
    }
  ],
  "devices": [
    {
      "hostName": "Device_4"
    },
    {
      "uniqueId": "90491678-096c-4223-9867-f31c37ff09da"
    }
  ],
  "installPatch": false,
  "locations": [
    {
      "name": "LOC-1"
    },
    {
      "id": "12"
    }
  ],
  "name": "Recurring-monthly-1schedule",
  "runRBA": false,
  "schedule": {
    "endTime": "2015-05-29T18:55:27+0000",
    "pattern": {
      "dayOfMonth": "14",
      "type": "monthly"
    },
    "startTime": "2015-05-28T10:55:27+0000",
    "timezone": "America/Puerto_Rico",
    "type": "Recurring"
  }
}
{
  "description": "Recurring-monthly-2schedule",
  "deviceGroups": [
    {
      "name": "DG-1"
    },
    {
      "id": "11"
    }
  ],
  "devices": [
    {
      "hostName": "Device_2"
    },
    {
      "id": "10"
    }
  ],
  "installPatch": false,
  "locations": [
    {
      "name": "LOC-1"
    },
    {
      "id": "12"
    }
  ],
  "name": "Recurring-monthly-2schedule",
  "runRBA": false,
  "schedule": {
    "endTime": "2015-05-29T18:55:27+0000",
    "pattern": {
      "dayOfWeek": "Thursday",
      "type": "monthly",
      "weekIndex": "Third"
    },
    "startTime": "2015-05-28T10:55:27+0000",
    "timezone": "America/Los_Angeles",
    "type": "Recurring"
  }
}
{
  "description": "Onetimeschedule",
  "deviceGroups": [
    {
      "name": "DG-1"
    },
    {
      "id": "11"
    }
  ],
  "devices": [
    {
      "hostName": "device-1"
    },
    {
      "uniqueId": "90491678-096c-4223-9867-f31c37ff09da"
    }
  ],
  "installPatch": false,
  "locations": [
    {
      "name": "LOC-1"
    },
    {
      "id": "12"
    }
  ],
  "name": "Onetimeschedule",
  "runRBA": false,
  "schedule": {
    "endTime": "2016-05-29T18:55:27+0000",
    "startTime": "2015-05-28T10:55:27+0000",
    "timezone": "America/New_York",
    "type": "One-Time"
  }
}
{
  "description": "Recurring-weeklyschedule",
  "deviceGroups": [
    {
      "name": "DG-1"
    },
    {
      "id": "11"
    }
  ],
  "devices": [
    {
      "hostName": "Device_1"
    },
    {
      "uniqueId": "90491678-096c-4223-9867-f31c37ff09da"
    }
  ],
  "installPatch": false,
  "locations": [
    {
      "name": "LOC-1"
    },
    {
      "id": "12"
    }
  ],
  "name": "Recurring-weeklyschedule",
  "runRBA": false,
  "schedule": {
    "endTime": "2015-05-29T18:55:27+0000",
    "pattern": {
      "type": "weekly",
      "weekDays": "Wednesday,Thursday"
    },
    "startTime": "2015-05-28T10:55:27+0000",
    "timezone": "America/Puerto_Rico",
    "type": "Recurring"
  }
}

Responses

OK

uniqueId
string

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