Documentation is now available for the Fall 2020 Update release!

Create one-time schedule

This endpoint is used to create a one-time schedule for the device, device group, and site.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/scheduleMaintenances

Sample URLs

https://{api-url}/api/v2/tenants/client_93/scheduleMaintenances

Parameters

FieldData TypeDescription
nameStringName of schedule maintenance.
descriptionStringDescription of maintenance window.
devices/deviceGroups/locationsStringDetails of resources which should be added to schedule maintenance window. No more than 100 resources can be added to a schedule maintenance window.
schedule
  1. type
  2. startTime
  3. endTime
  4. timezone
StringType of schedule:
  1. One-Time only.
  2. Time when the schedule should start.
  3. Time when the schedule should end.
  4. Timezone used for the schedule. (The list of timezones are shown below.)
    Example: "timezone":  "America/New_York"
runRBABoolean(Optional) Set runRBA=true to run RBA scripts; otherwise, set to false.
installPatchBoolean(Optional) Set installPatch=true to install patch.
runEscalationActionBoolean(Optional) Provide runEscalationAction: true to escalate maintenance alerts after schedule maintenance is completed. If no value is provided, the default value is true.
alertConditions
  1. matchingType
  2. rules
    1. key
    2. operator
    3. value
String(Optional) For specific alerts to be triggered as maintenance alerts, configure the below alert conditions. Alerts that do match with the below conditions are triggered as monitoring alerts:
  1. Alert conditions should match ALL or ANY of the rules.
  2. Conditions for filter alerts:
    1. Unique attribute of alert.
    2. Logical operators to filter alertsSupported values: Equals, NotEquals, Equals, NotEquals, Startswith, Endswith, Regex. See Regular Expressions to filter alerts with operator Regex.
    3. Unique data of alert.
      Example: Cloud Controller Discovery
Timezones
Pacific/AsiaPacific/HonoluluAmerica/Anchorage
America/Los_AngelesAmerica/DenverAmerica/Chicago
America/New_YorkAmerica/Puerto_RicoAmerica/St_Johns
America/Buenos_AiresAtlantic/AzoresEurope/London
Europe/ParisEurope/IstanbulAfrica/Addis_Ababa
Asia/TehranAsia/YerevanAsia/Karachi
Asia/CalcuttaAsia/DaccaAsia/Saigon
Asia/ShanghaiAsia/TokyoAustralia/Darwin
Australia/SydneyPacific/GuadalcanalPacific/Auckland

Sample request

{
	"name": "Onetimeschedule",
	"description": "Onetimeschedule",
	"runRBA": "false",
	"installPatch": "false",
	"devices": [{
			"hostName": "device-1"
		},
		{
			"uniqueId": "90491678-096c-4223-9867-f31c37ff09da"
		}
	],
	"deviceGroups": [{
			"name": "DG-1"
		},
		{
			"id": "11"
		}
	],
	"locations": [{
			"name": "LOC-1"
		},
		{
			"id": "12"
		}
	],
	"schedule": {
		"type": "One-Time",
		"startTime": "2015-05-28T10:55:27+0000",
		"endTime": "2016-05-29T18:55:27+0000",
		"timezone": "America/New_York"
	}
}

Sample response

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