Skip to main content

getMaintenanceWindowsList

This method will display a list of available Maintenance Windows for a company.

Parameters

Parameter

Type

Optional

Description

type

Number

Yes

The type of maintenance windows to retrieve. If not provided, all windows will be retrieved. The only available value is 0 - Patch Management.

page

Number

Yes

The results page number. The default value is 1.

perpage

Number

Yes

The number of items displayed in a page. The upper limit is 100 items per page. Default value: 30 items per page

Return value

This method returns an Object containing information on the Maintanace Windows available for a company. The returned object contains:

  • page - the current page

  • pagesCount - the current number of available pages

  • perPage - the total number of returned items per page

  • total - the total number of items

  • items - contains the maintenance list. Each entry in the list has the following keys:

    • id - the maintenance window id

    • name - the maintenance window name

    • type - the maintenance window type. Possible values: 0 - Patch Management

Example

Request

{
    "id": "49defe1e-4b5b-4de6-a568-468d09cc5241",
    "jsonrpc": "2.0",
    "method": "getMaintenanceWindowsList",
    "params": {}
}

Response

{
  "id": "49defe1e-4b5b-4de6-a568-468d09cc5241",
  "jsonrpc": "2.0",
  "result": {
    "items": [
      {
        "id": "6328d1f338e4e3127c1d8ce7",
        "name": "Maintenance Window 1",
        "type": 0
      },
      {
        "id": "6328d1f338e4e3127c1d8ce8",
        "name": "Maintenance Window 2",
        "type": 0
      }
    ]
  }
}
In this section: