Endpoint
/api/v2/tenants/{tenantId}/scheduleMaintenances/{smId}

Deletes a scheduled maintenance window.

Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

smId
string

Scheduled maintenance unique identifier

Responses

OK

Endpoint
/api/v2/tenants/{tenantId}/scheduleMaintenances/{smId}

Gets scheduled maintenance window details.

Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

smId
string

Scheduled maintenance unique identifier

schedule
object

Schedule details:

schedule.endTime
Time at which the schedule activity should end.
schedule.pattern
Schedule pattern:
schedule.startTime
Time at which the schedule activity should begin.
schedule.type
Schedule type.
{
  "schedule": {
    "endTime": "2017-05-11T18:00:00+0000",
    "pattern": {
      "dayFrequency": "everyday",
      "repeatFrequency": 2,
      "type": "daily"
    },
    "startTime": "2017-05-05T09:00:00+0000",
    "type": "recurring"
  }
}
{
  "schedule": {
    "endTime": "2017-05-11T16:00:00+0000",
    "pattern": {
      "dayFrequency": "every weekday",
      "type": "daily"
    },
    "startTime": "2017-05-05T14:00:00+0000",
    "type": "recurring"
  }
}
{
  "schedule": {
    "endTime": "2017-05-17T11:00:00+0000",
    "pattern": {
      "dayOfWeek": "Saturday",
      "type": "monthly",
      "weekIndex": "Last"
    },
    "startTime": "2017-05-05T03:00:00+0000",
    "type": "recurring"
  }
}
{
  "schedule": {
    "endTime": "2017-05-24T13:00:00+0000",
    "pattern": {
      "dayOfMonth": "02,03",
      "type": "monthly"
    },
    "startTime": "2017-05-05T04:00:00+0000",
    "type": "recurring"
  }
}
{
  "schedule": {
    "endTime": "2017-05-25T19:00:00+0000",
    "pattern": {
      "type": "weekly",
      "weekDays": "Monday,Tuesday"
    },
    "startTime": "2017-05-05T13:00:00+0000",
    "type": "recurring"
  }
}

Responses

OK

results
array

results.createdTime
results.deviceGroups
results.devices
results.dontInstallPatch
results.dontRunRBA
results.installPatch
results.locations
results.name
results.runRBA
results.schedule
results.status
results.uniqueId
results.updatedTime
{
  "createdTime": "2017-08-11T06:19:09+0000",
  "deviceGroups": [
    {
      "createdTime": 1469345264000,
      "description": "Windows Systems at SJ",
      "name": "SJ-WINDOWS",
      "updatedTime": 1469345595000
    }
  ],
  "devices": [
    {
      "clientUniqueId": "client_8",
      "generalInfo": {
        "hostName": "172.26.103.1",
        "ipAddresses": "172.26.103.1",
        "osName": "Microsoft(R) Windows(R) Server 2003, Enterprise Edition Service Pack 2"
      },
      "id": "edd5e6db-3e7f-4292-9e7f-ab1532ce3b6c",
      "type": "DEVICE"
    },
    {
      "clientUniqueId": "client_8",
      "generalInfo": {
        "hostName": "AZR-OS-1",
        "ipAddresses": "10.6.0.4",
        "osName": "Microsoft Windows Server 2008 R2 Datacenter Edition Service Pack 1, 64-bit"
      },
      "id": "12f2deff-f3ca-47f6-bb5d-3b9292dd8a0b",
      "type": "DEVICE"
    }
  ],
  "dontInstallPatch": "true",
  "dontRunRBA": "true",
  "installPatch": false,
  "locations": [
    {
      "address": "Parkway",
      "city": "San Jose",
      "clientId": 8,
      "country": "United States",
      "description": "SJ Lab",
      "id": 3,
      "mspId": 6,
      "name": "SJ-AD LAB",
      "phoneNumber": "",
      "primaryContact": {
        "email": "john.smith@luminalto.com",
        "firstName": "ops",
        "id": "USR0000000014",
        "lastName": "Lab",
        "loginName": "opsLab@luminalto.com",
        "phoneNumber": "408-555-1234"
      },
      "state": "California"
    },
    {
      "address": "Blossom Valley",
      "city": "San Jose",
      "clientId": 8,
      "country": "United States",
      "description": "East Labs",
      "id": 5,
      "mspId": 6,
      "name": "SJ-EAST LAB",
      "phoneNumber": "408-555-1230",
      "primaryContact": {
        "email": "john.smith@luminalto.com",
        "firstName": "ops",
        "id": "USR0000000014",
        "lastName": "Lab",
        "loginName": "opsLab@luminalto.com",
        "phoneNumber": "408-555-1234"
      },
      "state": "California"
    }
  ],
  "name": "Under Maintenance",
  "runRBA": false,
  "schedule": {
    "endTime": "2017-08-15T23:00:00+0000",
    "startTime": "2017-08-11T10:00:00+0000",
    "type": "one-time"
  },
  "status": "Completed",
  "uniqueId": "SM-d765c8d5-7df6-49ec-9bb0-4cd82b945c96",
  "updatedTime": "2017-11-02T11:08:52+0000"
}
Endpoint
/api/v2/tenants/{tenantId}/scheduleMaintenances/{smId}

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”

Timezones

Region/CityRegion/CityRegion/City
Pacific/AsiaPacific/HonoluluAmerica/Anchorage
America/Los_AngelesAmerica/DenverAmerica/Chicago
America/New_YorkAmerica/Puerto_RicoAmerica/St_Johns
America/Buenos_AiresAtlantic/AzoresGMT
Europe/ParisEurope/IstanbulAfrica/Addis_Ababa
Asia/TehranAsia/YerevanAsia/Karachi
Asia/CalcuttaAsia/DaccaAsia/Saigon
Asia/ShanghaiAsia/TokyoAustralia/Darwin
Australia/SydneyPacific/GuadalcanalPacific/Auckland

Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

smId
string

Scheduled maintenance unique identifier

alertConditions
object

(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

alertConditions.matchingType
alertConditions.rules
description
string

Schedule description.

installPatch
boolean

(Optional) Set installPatch=true to install patch; otherwise, set to false.

name
string

Schedule name.

runEscalationAction
boolean

(Optional) Provide runEscalationAction: true to escalate maintenance alerts after schedule maintenance is completed. If no value is provided, the default value is true.

runRBA
boolean

(Optional) Set runRBA=true to run RBA scripts; otherwise, set to false.

schedule
object

Schedule details:

schedule.endTime
Time at which the schedule activity should end.
schedule.pattern
Schedule pattern:
schedule.startTime
Time at which the schedule activity should begin.
schedule.timezone
Timezone in which the schedule should operate. (The list of timezones are shown below.) Example: "timezone": "America/Puerto_Rico"
schedule.type
Schedule type.
{
  "alertConditions": {
    "matchingType": "ANY",
    "rules": [
      {
        "key": "subject",
        "operator": "CONTAINS",
        "value": "newTest"
      },
      {
        "key": "description",
        "operator": "CONTAINS",
        "value": "test Description"
      },
      {
        "key": "serviceName",
        "operator": "CONTAINS",
        "value": "newTest"
      }
    ]
  },
  "description": "Recurring maintenance",
  "installPatch": "false",
  "name": "Network devices schedule maintenance",
  "runRBA": "false",
  "schedule": {
    "endTime": "2018-08-19T18:55:27+0000",
    "pattern": {
      "type": "weekly",
      "weekDays": "Wednesday,Thursday"
    },
    "startTime": "2018-08-18T10:55:27+0000",
    "timezone": "GMT",
    "type": "Recurring"
  }
}

Responses

OK

uniqueId
string

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