CLOUD SOLUTIONS

getNetworkInventoryItems

This method returns network inventory items.

Parameters

Parameter

Type

Optional

Description

parentId

String

Yes

The ID of the target company or group. If not specified, the method returns items that are in the targets of the company linked to the API key.

filters

Object

Yes

The filters to be used when querying the endpoints list. For information regarding the available filters and how to use them, refer to Available Filters.

page

Number

Yes

The results page number. Default page number is 1.

perPage

Number

Yes

Number of items per page to be returned. The upper limit is 100 items per page. Default value: 30 items per page.

options

Object

Yes

A set of options that can be specified in order to control what information is present in the request. For information regarding the available filters and how to use them, refer to Available Options.

Available Options

You can use the options parameter to control what data is returned in the response.

Section

Subsection

Options

companies

  • returnAllProducts - if true, information about all the products of the given company will also be present in the response. This parameter is optional. Default value: False.

Available filters

Section

Subsection

Filtering Options

type

  • groups - a Boolean to filter all custom groups of endpoints. Default value: False.

  • ec2Instances - a Boolean to filter all Amazon EC2 Instances. Default value: False.

  • computers - a Boolean to filter all computers. Default value: False.

  • virtualMachines - a Boolean to filter all virtual machines. Default value: False.

security

management

  • managedWithBest - a Boolean to filter all endpoints with the security agent installed on them. Default value: False.

  • isContainerHost - a Boolean to filter all endpoints with container host protection installed on them. Default value: False.

    This filter is available for computers and virtualmachines services.

  • managedExchangeServers - a Boolean to filter all protected Exchange servers. Default value: False.

    This filter requires a valid license key that covers the security service.

  • managedRelays - a Boolean to filter all endpoints with Relay role. Default value: False.

  • securityServers - a Boolean to filter all Security Servers. Default value: False.

depth

  • allItemsRecursively - a Boolean to filter all endpoints recursively within the Network Inventory of a company. Default value: False.

details

  • ssid - string, the SSID (Active Directory SID of the endpoint) used to filter the endpoints regardless of their protection status.

  • macs - array, the list of MAC addresses used to filter the endpoints regardless of their protection status.

  • name - a String for filtering the items by name. Minimum required string length is three characters.

Important

Some filters require a specific license to be active, otherwise they are ignored, resulting in an inaccurate API response.

The field name works with partial matching.

The filter returns the items whose names are exact match or start with the specified value. To use the specified value as a suffix, use the asterisk symbol (*).

For example:

If name is computer, the API returns all items whose names start with computer.

If name is *puter, then the API returns a list of all items that contain puter in their names.

Return value

This method returns an Object containing information about the network items. The returned object contains:

  • page - the current page

  • pagesCount - the total number of pages

  • perPage - the total number of items returned per page

  • total - the total number of items

  • items - an array containing the list of items. Each entry in the list has the following fields:

    • id, the ID of the network item,

    • name, the name of the network item,

    • parentId, the ID of the parent container,

    • companyId, the ID of the parent company,

    • type, the type of network item: 1 - Company, 2 - Root Container (Companies and Network containers), 3 - Company Folder, 4 - Group, 5 - Computer, 6 - Virtual Machine, 7 - EC2 Instance, 14 - Containers Group, 15 - Container Host Folder, 16 - Container.

    • details, more information about the item. This field is available for 1 - Companies, 5 - Computers, 6 - Virtual Machines, 7 - EC2 Instances and 16 - Containers. For information regarding the content of the details member please refer to The details member.

The details member

Some network inventory items contain a details member. This member exposes more information regarding the item. The information depends on the item type.

Item type

Details

5(computer), 6(virtual machine) and 7(EC2 Instance)

  • label, the label set to the endpoint

  • fqdn, the FQDN of the endpoint

  • groupId, the group ID of the endpoint

  • isManaged, boolean True, if this endpoint is managed

  • machineType, the type of the machine: (1 - computer, 2 - virtual machine, 3 - EC2 Instance, 0 - Other)

  • operatingSystemVersion, the OS version of the endpoint

  • ip, the IP address of the endpoint

  • macs, the list of MAC addresses of the endpoint

  • ssid, the Active Directory SID of the endpoint

  • managedWithBest, boolean True, if BEST is installed on this endpoint

  • isContainerHost, boolean True, if this endpoint is a Container Host

  • managedExchangeServer, boolean True, if this endpoint is an Exchange Server

  • managedRelay, boolean True, if this endpoint has Relay role

  • securityServer, boolean True, if this endpoint is a Security Server

  • policy - an Object informing about the policy active on the endpoint. The object contains the following fields:

    • id, a String uniquely identifying the active policy

    • name, the name of the policy

    • applied, a Boolean set to True if the policy is currently applied on the endpoint

  • movingInfo - an Object informing upon endpoint transfer from one company to another one. The object contains:

    • state, the endpoint moving status (0 - in progress, 1 - moved)

    • destinationCompanyName, the name of the company where the endpoint was moved.

  • modules - an Object informing of the installed modules and their statuses. The fields have Boolean values, True - if the module is enabled, or False - if the module is disabled. The available fields are:

    • advancedThreatControl

    • antimalware

    • contentControl

    • deviceControl

    • firewall

    • powerUser

    • encryption

    • edrSensor

    • hyperDetect

    • patchManagement

    • relay

    • sandboxAnalyzer

    • exchange

    • advancedAntiExploit

    • containerProtection

    • networkAttackDefense

Example

Request:

  {
       "params": {
           "parentId": "23b19c39b1a43d89367b32ce",
           "page": 1,
           "perPage": 1,
           "filters": {
               "type": {
                   "computers": true
               },
               "depth": {
                   "allItemsRecursively": true
               }
           },
           "options": {
               "companies": {
                   "returnAllProducts": true
               }
           }
       },
       "jsonrpc": "2.0",
       "method": "getNetworkInventoryItems",
       "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b"
  }  

Response:

  {
      "id":"103d7b05-ec02-481b-9ed6-c07b97de2b7a",
      "jsonrpc":"2.0",
      "result": {
           page: 2,
           pagesCount: 11,
           perPage: 1,
           total: 11
           items[
               {
                   "id" : "21a295eeb1a43d8b497b24b7",
                   "name" : "Computer",
                   "type" : 5,
                   "parentId": "21a295eeb1a43d8b497b24b7",
                   "companyId": "21a295eeb1a43d8b497b24b7",
                   "details" : {
                       "label" : "endpoint 2",
                       "fqdn": "endpoint2.local",
                       "groupId": "5a5f4d36b1a43d5f097b23bb",
                       "isManaged": true,
                       "machineType": 2,
                       "operatingSystemVersion": "Windows Server",
                       "ip": "60.40.10.220",
                       "macs": [
                            "324935237346"
                       ],
                       "modules": {
                                      "advancedThreatControl": False,
                                      "antimalware": True,
                                      "contentControl": False,
                                      "deviceControl": False,
                                      "firewall": False,
                                      "powerUser": False,
                                      "networkAttackDefense": False
                                  },
                       "ssid": "",
                   }
               }
           ]
      }
  }