PARTNERS

getMaintenanceWindowDetails

This method retrieves all the information related to a maintenance window. It can only apply to your own company or companies that can be managed from above.

Parameters

Parameter

Type

Optional

Description

Id

String

No

The ID of the queried maintenance window

Return value

Returns an object with the details of the queried maintenance window:

  • id - the ID of the queried maintenance window

  • name - the name of the queried maintenance window

  • allowChangeByOtherUsers - true if users other than to owner can modify the maintenance

  • inPolicies - number of policies that the maintenance window is assigned to

  • createdBy - the username of the user who created the maintenance

  • createDate - the date when the maintenance window was created

  • lastModifiedBy - the username of the user who last modified the maintenance window

  • lastModifyDate - the date when the maintenance window was last modified

  • status - 1 if used in policy, 0 if not

  • type - 0 for Patch Management maintenance window

  • settings - the settings of the maintenance window. For more information on the available settings refer to Settings.

Example

Request:

{
  "method": "getMaintenanceWindowDetails",
  "id": "5f4ae6f7-6b5c-4c19-9868-ec80917d538b",
  "jsonrpc": "2.0",
  "params": {
    "id": "61975cb3ba000f42e028cfe9"
  }
}

Response:

{
  "id": "5f4ae6f7-6b5c-4c19-9868-ec80917d538b",
  "jsonrpc": "2.0",
  "result": {
    "allowChangeByOtherUsers": false,
    "createDate": "2021-11-19T08:13:39",
    "createdBy": "Partner9TKyS0LDMF",
    "id": "61975cb3ba000f42e028cfe9",
    "inPolicies": 0,
    "lastModifiedBy": "Partner9TKyS0LDMF",
    "lastModifyDate": "2021-11-19T08:13:39",
    "name": "EAiiEO5RuTr7hoqxmXRC",
    "settings": {
      "downloadSettings": {
        "cachingServers": [
          
        ],
        "fallbackOnDirectDownload": true
      },
      "installPatchesSettings": {
        "enabled": false,
        "ifMissedRunAsSoonAsPossible": false,
        "specificVendorAndProduct": {
          "enabled": false,
          "type": 1,
          "vendorProductsPairs": [
            
          ]
        },
        "updateType": {
          "nonSecurityPatchesSettings": {
            "enabled": false
          },
          "securityPatchesSettings": {
            "enabled": false
          }
        }
      },
      "scanPatchesSettings": {
        "enabled": false,
        "runOnSystemChanges": true,
        "useFallbackSchedule": false,
        "useSameSchedule": false
      }
    },
    "status": 1,
    "type": 0
  }
}