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
Local Time as per defined timeZone at which the schedule activity should end.
schedule.pattern
Schedule pattern
schedule.startTime
Local time as per defined timeZone 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.alertConditions
results.createdBy
results.createdTime
results.description
results.deviceGroups
results.devices
results.dontInstallPatch
results.dontRunRBA
results.id
results.installPatch
results.locations
results.name
results.policyUniqueId
results.runEscalateAction
results.runRBA
results.schedule
Describes the Scheduling time period and recurring pattern of the Scheduled Maintainence Windows
results.status
results.uniqueId
results.updatedBy
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

alertConditions.matchingType
alertConditions.policyUniqueId
alertConditions.rules
description
string

dontInstallPatch
boolean

dontRunRBA
string

installPatch
boolean

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

{
  "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"
}