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

Describes the client ID or msp ID of the tenant

Query Parameters
pageNo
integer

pageSize
integer

isDescendingOrder
boolean

sortName
string

queryString
string

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

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
totalPages
integer

totalResults
integer

{
  "descendingOrder": true,
  "nextPage": false,
  "pageNo": 1,
  "pageSize": 100,
  "previousPageNo": 0,
  "results": [
    {
      "createdBy": 11083,
      "createdTime": "2021-07-25T03:12:02+0000",
      "description": "Monthly-recurring-never-ends",
      "devices": [
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "vjp02-kailash-sjc",
            "ipAddresses": "172.26.22.95",
            "name": "vjp02-kailash-sjc",
            "osName": "Linux",
            "resourceName": "",
            "resourceType": "Linux"
          },
          "id": "4b93211e-776e-4555-811d-ef8a1f300ca0",
          "type": "DEVICE"
        },
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "vjp03-kailash-sjc",
            "ipAddresses": "172.26.22.96",
            "name": "vjp03-kailash-sjc",
            "osName": "Linux",
            "resourceName": "",
            "resourceType": "Linux"
          },
          "id": "cf98748d-bad9-4469-b21d-db3d521720b3",
          "type": "DEVICE"
        }
      ],
      "dontInstallPatch": "true",
      "dontRunRBA": "false",
      "id": 0,
      "installPatch": false,
      "name": "Recurring-Monthly",
      "runEscalateAction": true,
      "runRBA": true,
      "schedule": {
        "endBy": "Never",
        "endTime": "2021-10-01T12:00:00+0530",
        "pattern": {
          "dayOfWeek": "Wednesday",
          "type": "monthly",
          "weekIndex": "Second"
        },
        "startTime": "2021-10-01T06:00:00+0530",
        "timezone": "Asia/Calcutta",
        "type": "recurring"
      },
      "status": "Pending",
      "uniqueId": "SM-12cf031e-ef33-4318-9707-e3f86817f562",
      "updatedBy": 0,
      "updatedTime": ""
    },
    {
      "createdBy": 11083,
      "createdTime": "2021-07-25T03:11:06+0000",
      "description": "Recurring-monthly-day-of-month",
      "devices": [
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "vjp01-kailash-sjc",
            "ipAddresses": "172.26.22.94",
            "name": "vjp01-kailash-sjc",
            "osName": "Linux",
            "resourceName": "",
            "resourceType": "Linux"
          },
          "id": "5ecd2c90-4689-456c-adb0-02b131c61717",
          "type": "DEVICE"
        },
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "vjp02-kailash-sjc",
            "ipAddresses": "172.26.22.95",
            "name": "vjp02-kailash-sjc",
            "osName": "Linux",
            "resourceName": "",
            "resourceType": "Linux"
          },
          "id": "4b93211e-776e-4555-811d-ef8a1f300ca0",
          "type": "DEVICE"
        },
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "vjp-reports01-kailash-sjc",
            "ipAddresses": "172.26.22.90",
            "name": "vjp-reports01-kailash-sjc",
            "osName": "Linux",
            "resourceName": "",
            "resourceType": "Linux"
          },
          "id": "98372573-035f-4a2b-a19b-da778a1a3be5",
          "type": "DEVICE"
        },
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "vjp-metricmonitor01-kailash-sjc",
            "ipAddresses": "172.26.22.100",
            "name": "vjp-metricmonitor01-kailash-sjc",
            "osName": "Linux",
            "resourceName": "",
            "resourceType": "Linux"
          },
          "id": "94a31045-a374-41b4-98d3-2e037feb7ccf",
          "type": "DEVICE"
        }
      ],
      "dontInstallPatch": "true",
      "dontRunRBA": "true",
      "id": 0,
      "installPatch": false,
      "name": "Monthly-day-of-month",
      "runEscalateAction": true,
      "runRBA": false,
      "schedule": {
        "endBy": "Never",
        "endTime": "2021-10-01T14:00:00-0300",
        "pattern": {
          "dayOfMonth": "02,05,07",
          "type": "monthly"
        },
        "startTime": "2021-10-01T09:13:00-0300",
        "timezone": "America/Buenos_Aires",
        "type": "recurring"
      },
      "status": "Pending",
      "uniqueId": "SM-af41af59-277a-4364-a82d-035a351d457f",
      "updatedBy": 0,
      "updatedTime": ""
    },
    {
      "createdBy": 11083,
      "createdTime": "2021-07-25T03:09:55+0000",
      "description": "Recurring-daily-frequency",
      "devices": [
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "vhdfs03-kailash-sjc",
            "ipAddresses": "172.26.22.73",
            "name": "vhdfs03-kailash-sjc",
            "osName": "Linux",
            "resourceName": "",
            "resourceType": "Linux"
          },
          "id": "1a1a1884-a719-4d5d-a002-c627087f4902",
          "type": "DEVICE"
        },
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "vapp02-trisul-sjc",
            "ipAddresses": "172.26.17.12",
            "name": "vapp02-trisul-sjc",
            "osName": "Ubuntu 18.04.2 LTS",
            "resourceName": "",
            "resourceType": "Linux"
          },
          "id": "cf70e6bf-e355-4a64-aec2-12673b533403",
          "type": "DEVICE"
        },
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "vjp-availability02-kailash-sjc",
            "ipAddresses": "172.26.22.103",
            "name": "vjp-availability02-kailash-sjc",
            "osName": "Linux",
            "resourceName": "",
            "resourceType": "Linux"
          },
          "id": "d8baa795-cd1d-4808-a053-185e06f59f59",
          "type": "DEVICE"
        },
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "vhdfs02-kailash-sjc",
            "ipAddresses": "172.26.22.72",
            "name": "vhdfs02-kailash-sjc",
            "osName": "Linux",
            "resourceName": "",
            "resourceType": "Linux"
          },
          "id": "2e40073b-2b16-4278-b897-bbf6f16719ca",
          "type": "DEVICE"
        },
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "vjp-alertsla01-kailash-sjc",
            "ipAddresses": "172.26.22.97",
            "name": "vjp-alertsla01-kailash-sjc",
            "osName": "Linux",
            "resourceName": "",
            "resourceType": "Linux"
          },
          "id": "25c5ca84-26da-4b0b-aba4-cc254bc0e71a",
          "type": "DEVICE"
        }
      ],
      "dontInstallPatch": "true",
      "dontRunRBA": "true",
      "id": 0,
      "installPatch": false,
      "name": "Daily-with-frequency",
      "runEscalateAction": true,
      "runRBA": false,
      "schedule": {
        "endBy": "Never",
        "endTime": "2021-10-01T15:00:00+0530",
        "pattern": {
          "dayFrequency": "everyday",
          "repeatFrequency": 5,
          "type": "daily"
        },
        "startTime": "2021-10-01T04:00:00+0530",
        "timezone": "Asia/Calcutta",
        "type": "recurring"
      },
      "status": "Pending",
      "uniqueId": "SM-c3c24f04-035b-4ff3-b162-c835b2b7a89f",
      "updatedBy": 0,
      "updatedTime": ""
    },
    {
      "alertConditions": {
        "matchingType": "ANY",
        "policyUniqueId": "POLICY-98b09d3b-10a5-45a5-aa0f-323100ce3975",
        "rules": [
          {
            "key": "Alert : Metric",
            "operator": "contains",
            "value": " mysql.innodb.row.lock.waits"
          },
          {
            "key": "Alert : Description",
            "operator": "equals",
            "value": "testdec"
          },
          {
            "key": "Alert : Subject",
            "operator": "startswith",
            "value": "subject"
          }
        ]
      },
      "createdBy": 11083,
      "createdTime": "2021-07-25T03:02:41+0000",
      "description": "Test-weeky-on-given-days",
      "devices": [
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "",
            "ipAddresses": "10.128.15.201",
            "name": "gke-opsqagcp2-default-pool-83b7791b-rer2",
            "resourceName": "gke-opsqagcp2-default-pool-83b7791b-rer2",
            "resourceType": "Server"
          },
          "id": "66ff9621-af3e-495b-9346-09f859c129d9",
          "type": "DEVICE"
        },
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "",
            "ipAddresses": "10.128.15.202",
            "name": "gke-kritis-test-default-pool-12cf78c3-odqb",
            "resourceName": "gke-kritis-test-default-pool-12cf78c3-odqb",
            "resourceType": "Server"
          },
          "id": "13397864-9841-427b-8201-a4a29d2941dc",
          "type": "DEVICE"
        },
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "",
            "ipAddresses": "10.128.15.199",
            "name": "gke-opsqagcp2-default-pool-83b7791b-v12f",
            "resourceName": "gke-opsqagcp2-default-pool-83b7791b-v12f",
            "resourceType": "Server"
          },
          "id": "35cea90b-b8d2-4f51-b36f-069fd4b211b0",
          "type": "DEVICE"
        },
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "",
            "ipAddresses": "10.128.15.196",
            "name": "gke-opsqagcp2-default-pool-83b7791b-6wt0",
            "resourceName": "gke-opsqagcp2-default-pool-83b7791b-6wt0",
            "resourceType": "Server"
          },
          "id": "10cbf9d2-bbab-47ef-9123-317de7a8d8ae",
          "type": "DEVICE"
        }
      ],
      "dontInstallPatch": "true",
      "dontRunRBA": "true",
      "id": 0,
      "installPatch": false,
      "name": "Test-recurring-weekly",
      "runEscalateAction": true,
      "runRBA": false,
      "schedule": {
        "endTime": "2021-11-30T15:00:00+0530",
        "pattern": {
          "type": "weekly",
          "weekDays": "Sunday,Tuesday,Saturday"
        },
        "startTime": "2021-10-01T07:00:00+0530",
        "timezone": "Asia/Calcutta",
        "type": "recurring"
      },
      "status": "Pending",
      "uniqueId": "SM-0459dd4c-5d99-4e60-b441-d800a39fcc0a",
      "updatedBy": 0,
      "updatedTime": ""
    },
    {
      "createdBy": 2,
      "createdTime": "2021-07-25T02:50:04+0000",
      "description": "Test",
      "devices": [
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "HYDLPT220",
            "ipAddresses": "172.24.133.34",
            "name": "HYDLPT220",
            "osBuildNumber": "17763",
            "osName": "Microsoft Windows 10 Pro, 64-bit",
            "resourceName": "",
            "resourceType": "Laptop"
          },
          "id": "2f006a09-ee6a-424f-a50f-6ca5d5b0a733",
          "type": "DEVICE"
        }
      ],
      "dontInstallPatch": "false",
      "dontRunRBA": "false",
      "id": 0,
      "installPatch": true,
      "name": "Test-1-weekly",
      "runEscalateAction": true,
      "runRBA": true,
      "schedule": {
        "endTime": "2021-08-29T11:55:27-0700",
        "pattern": {
          "type": "weekly",
          "weekDays": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday"
        },
        "startTime": "2021-08-12T03:55:27-0700",
        "timezone": "America/Los_Angeles",
        "type": "recurring"
      },
      "status": "Pending",
      "uniqueId": "SM-5267d7d8-41f1-4a2d-8b43-9c9d6116b7a7",
      "updatedBy": 0,
      "updatedTime": ""
    },
    {
      "createdBy": 2,
      "createdTime": "2021-07-24T14:25:04+0000",
      "description": "Schedule-One-time",
      "devices": [
        {
          "clientUniqueId": "client_13598",
          "generalInfo": {
            "aliasName": "",
            "hostName": "HYDLPT220",
            "ipAddresses": "172.24.133.34",
            "name": "HYDLPT220",
            "osBuildNumber": "17763",
            "osName": "Microsoft Windows 10 Pro, 64-bit",
            "resourceName": "",
            "resourceType": "Laptop"
          },
          "id": "2f006a09-ee6a-424f-a50f-6ca5d5b0a733",
          "type": "DEVICE"
        }
      ],
      "dontInstallPatch": "false",
      "dontRunRBA": "false",
      "id": 0,
      "installPatch": true,
      "name": "Schedule-One-time",
      "runEscalateAction": true,
      "runRBA": true,
      "schedule": {
        "endTime": "2021-09-28T22:00:00-0700",
        "startTime": "2021-09-28T21:00:00-0700",
        "timezone": "America/Los_Angeles",
        "type": "one-time"
      },
      "status": "Pending",
      "uniqueId": "SM-151c5fe6-c02e-40eb-b611-6490269277a7",
      "updatedBy": 0,
      "updatedTime": ""
    },
    {
      "createdBy": 11943,
      "createdTime": "2020-01-28T11:24:07+0000",
      "description": "Completed-SM",
      "deviceGroups": [
        {
          "createdTime": 1517230206000,
          "description": "All Devices",
          "name": "All Devices"
        }
      ],
      "devices": [],
      "dontInstallPatch": "false",
      "dontRunRBA": "false",
      "id": 0,
      "installPatch": true,
      "name": "Completed-SM-ontime",
      "runEscalateAction": true,
      "runRBA": true,
      "schedule": {
        "endTime": "2020-01-28T21:00:00-0800",
        "startTime": "2020-01-28T20:00:00-0800",
        "timezone": "America/Los_Angeles",
        "type": "one-time"
      },
      "status": "Completed",
      "uniqueId": "SM-079e75d3-cbb0-4ae4-a3c6-01dc181adc5b",
      "updatedBy": 0,
      "updatedTime": ""
    }
  ],
  "totalPages": 1,
  "totalResults": 7
}