Skip to main content

getMaintenanceWindowsList

This method will display a list of available Maintenance Windows for a company. It only applies for companies where the user has visibility.

Parameters

Parameter

Type

Optional

Description

companyId

String

Yes

Company identifier

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:

    • companyId - the company id

    • companyName - the company name

    • id - the maintenance window id

    • name - the maintenance window name

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

Example

Request

{
  "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
  "jsonrpc": "2.0",
  "method": "getMaintenanceWindowsList",
  "params": {
    "companyId": "623b18f538e4e3127c1d8cd5",
    "type": 0,
    "page": 1,
    "perPage": 30
  }
}

Response

{
  "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
  "jsonrpc": "2.0",
  "result": {
    "page": 1,
    "pagesCount": 1,
    "perPage": 30,
    "total": 2,
    "items": [
      {
        "companyId": "623b18f538e4e3127c1d8cd5",
        "companyName": "My Company",
        "id": "6328d1f338e4e3127c1d8ce7",
        "name": "Maintenance Window 1",
        "type": 0
      },
      {
        "companyId": "623b18f538e4e3127c1d8cd5",
        "companyName": "My Company",
        "id": "6328d1f338e4e3127c1d8ce8",
        "name": "Maintenance Window 2",
        "type": 0
      }
    ]
  }
}
In this section: