Skip to main content

getPackagesList

Returns the list of available packages.

Parameters

Parameter

Type

Optional

Description

companyId

String

Yes

The ID of the company for which the packages list is retrieved. The default value is the company of the user who has generated the API key. If not passed, the packages available to the company are returned.

page

Number

Yes

The page number of results. Default page number 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 An object with information about the packages. The response object contains:

  • page - the current page displayed

  • pagesCount - the total number of available pages

  • perPage - the total number of returned items per page

  • total - the total number of items

  • items - the list of packages. Each entry in the list has the following fields: id, the ID of the package; name, the name of the package; type, the type of the package. The type can have the following values:

    • 3 Security Server

    • 4 Bitdefender Endpoint Security Tools

    • 5 Sandbox Analyzer

    • 6 Network Sensor appliance for Sandbox Analyzer

Example

Request:

  {
       "params": {
           "page": 1,
           "perPage": 5
       },
       "jsonrpc": "2.0",
       "method": "getPackagesList",
       "id": "696e1024-f94b-496a-9394-bee58b73c51f"
  }

Response:

  {
      "id":"103d7b05-ec02-481b-9ed6-c07b97de2b7a",
      "jsonrpc":"2.0",
      "result": {
           "page": 1,
           "pagesCount": 1,
           "perPage": 5,
           "total": 1,
           "items": [
               {
                   "id" : "55b8c1bfb1a43dd71071071b",
                   "name" : "Package Test",
                   "type": 3
               } 
           ]
      }
  }
In this section: