PARTNERS

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

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

  • companyFolders - a Boolean to filter all folders containing companies. Default value: False.

  • 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.

  • subscriptionType - an Array of Integers representing the list of license subscription types to filter companies:

    1 - companies with trial license,

    2 - companies with yearly license and Partner companies having a license key with monthly billing,

    3 - companies with monthly subscription,

    4 - companies with monthly license trial,

    5 - companies with monthly subscription trial

  • companyType - an Integer that filters companies by their relation with Bitdefender:

    0 - partner companies,

    1 - customer companies

  • 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

1 (company)

  • type - the company type: 0 for Partner, 1 for Customer

  • address - the physical address of the company

  • phone - the phone number of the company

  • canBeManagedByAbove - a Boolean indicating if the Partner can manage the security of that company

  • isSuspended - a Boolean informing whether the company account is suspended or not.

  • createdAt - a String representing the UTC date and time when the company was created.

  • licenseInfo - an Object containing information about the license subscription of the company:

    • subscriptionType - the company's subscription type: 1 for trial subscription, 2 for licensed subscription, 3 for monthly subscription, 4 for monthly license trial, 5 for monthly subscription trial, 6 for FRAT subscription

    • isAddon - whether the product is an add-on

    • expiryDate - the license expiry date

    • usedSlots - the number of used seats

    • totalSlots - the number of total seats for licensed subscriptions, or the number of reserved seats for child companies that inherited a monthly license from their parent company.

    • licenseKey - the license key for trial or licensed subscriptions.

    • endSubscription - the subscription end date. This option is available for companies with monthly subscription.

    • autoRenewPeriod - the subscription auto renewal period in months. This option is available for companies with monthly subscription.

    • manageExchange - True if the company is allowed to manage the Security for Exchange feature, false otherwise

    • manageEncryption - True if the company is allowed to manage the Full Disk Encryption feature, false otherwise

    • manageRemoteEnginesScanning - True if the company is allowed to manage the Security for Virtualized Environments feature, false otherwise

    • manageHyperDetect - True if the company is allowed to manage the HyperDetect feature, false otherwise

    • manageSandboxAnalyzer - True if the company is allowed to manage the Sandbox Analyzer feature, false otherwise

    • managePatchManagement - True if the company is allowed to manage the Patch Management feature, false otherwise

    • manageEventCorrelator - True if the company is allowed to manage the Endpoint Detection and Response feature, false otherwise.

    • manageEmailSecurity - True if the company is allowed to manage the Email Security feature, false otherwise.

    • manageContainerProtection - True if the company is allowed to manage the Container Protection feature, false otherwise.

    • minimumUsage - An Object containing types of licenses and the minimum number of slots which the company commits through legal agreement to use on a monthly basis:

      • endpointMonthlyUsage, the minimum number of endpoints that the client agreed to use from the main license.

    • assignedProductType - The type of product assigned to the company:

      • 0, for Endpoint Security

      • 3, for Bitdefender EDR

      The parameter is returned only when subscriptionType has one of these values:

      • 3, for monthly subscription

      • 5, for monthly subscription trial

    • additionalProductTypes - An array of the product types that can be assigned to child companies:

      • 0, for Endpoint Security

      • 3, for Bitdefender EDR

      The parameter is returned only when subscriptionType has one of these values:

      • 3, for monthly subscription

      • 5, for monthly subscription trial

    • reservedSlots - the number of total seats reserved for child companies. This option is available for Partner companies with monthly license.

    • additionalLicenses - Only present, if the company has multiple products (addons or base licenses) assigned. Array containing information about the addons and the main licenses assigned to the given company:

      • expiryDate, the license expiry date. If the product is an addon, this information is not available.

      • usedSlots, the number of used seats. If the product is an addon, this information is available only if the addon type is "Email Security" .

      • licenseKey, the license key for trial or licensed subscriptions.

      • isAddon, whether the product is an addon or a base license

  • country - a String representing the country code in ISO 3166 format. If the code is not specified, the String has the value N/A

  • state - a String representing the country state code in ISO 3166 format. If the code is not specified, the String has the value N/A

  • contactPerson - an Object containing the details of the contact person:

    • fullName, their first name and surname

    • email, their business email address

    • phoneNumber, their business phone number

    • companyRole, their position in the company

  • customFields - an Object containing the custom fields values for the company:

    • custom field name 1, custom field value 1

    • custom field name 2, custom field value 2

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.

Example

Request:

  {
       "params": {
           "parentId": "23b19c39b1a43d89367b32ce",
           "page": 2,
           "perPage": 3,
           "filters": {
               "type": {
                   "companies": true,
                   "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: 3,
           total: 33
           items[
               {
                   "id" : "21a295eeb1a43d8b497b23b7",
                   "name" : "Company 21",
                   "type" : 1,
                   "parentId": "21a295eeb1a43d8b497b22b7",
                   "companyId": "21a295eeb1a43d8b497b22b6",
                   "details": {
                       "type": 0,
                       "address": "Str Example No 1",
                       "phone": "0040740000001",
                       "canBeManagedByAbove": true, 
                       "isSuspended": false,
                       "createdAt": "2017-01-28T15:01:15",
                       "licenseInfo": {
                           "subscriptionType": 3,
                           "expiryDate": "2020-03-27T12:54:05",
                           "usedSlots": 0,
                           "reservedSlots": 0,
                           "endSubscription": "2020-04-14", 
                           "autoRenewPeriod": 12,
                           "totalSlots": null,
                           "manageExchange": false,
                           "manageEncryption": false,
                           "manageRemoteEnginesScanning": false,
                           "manageHyperDetect": false,
                           "manageSandboxAnalyzer": false,
                           "managePatchManagement": false,
                           "manageEventCorrelator": false,
                           "assignedProductType": 0,
                           "additionalProductType": [0]
                       },
                       "country": "CA",
                       "state": "CA-BC",
                       "contactPerson": {
                           "fullName": "Stephen Jhonson",
                           "email": "stephen.jhonsons@example.com",
                           "phoneNumber": "0040740000001",
                           "companyRole": "Owner / President"
                       },
                       "customFields":{
                           "referenceID":"004562",
                           "vertical":"healthcare",
                           "partner_type":"platinum",
                           "security_level":"high",
                           "payment_status":"goodstanding"
                       }
                   }
               },
               {
                   "id" : "21a295eeb1a43d8b497b24b7",
                   "name" : "company 22",
                   "type" : 1,
                   "parentId": "21a295eeb1a43d8b497b23b7",
                   "companyId": "21a295eeb1a43d8b497b23b6",
                   "details": {
                       "type": 0,
                       "address": "Str Example No 2",
                       "phone": "0040740000002",
                       "canBeManagedByAbove": true,
                       "isSuspended": false,
                       "createdAt": "2017-01-28T15:01:15",
                       "licenseInfo": {
                           "subscriptionType": 2,
                           "isAddon": false,
                           "expiryDate": "2023-03-19T17:21:50",
                           "usedSlots": 0,
                           "totalSlots": 50,
                           "licenseKey": "ARS4TSG",
                           "additionalLicenses": [
                               {
                                   "isAddon": false,
                                   "expiryDate": "2023-03-19T17:21:50",
                                   "usedSlots": 0,
                                   "totalSlots": 50,
                                   "licenseKey": "IDTGNAB"
                               },
                               {
                                   "isAddon": false,
                                   "expiryDate": "2024-05-19T17:21:50"
                                   "usedSlots": 0,
                                   "totalSlots": 50
                                   "licenseKey": "6AZJ8LG",
                               }
                           ]
                       },
                       "country": "CA",
                       "state": "CA-BC",
                       "contactPerson": {
                           "fullName": "Stephen Jhonson",
                           "email": "stephen.jhonsons@example.com",
                           "phoneNumber": "0040740000001",
                           "companyRole": "Owner / President"
                       }
                   }
               },
               {
                   "id" : "21a295eeb1a43d8b497b24b7",
                   "name" : "Computer 22",
                   "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"
                       ],
                       "ssid": "",
                   }
               }
           ]
      }
  }  
  {
       "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b",
       "jsonrpc": "2.0",
       "result": {
           "total": 3,
           "page": 1,
           "perPage": 30,
           "pagesCount": 1,
           "items": [
               {
                   "id": "615ac2346e25a86d3c06c932",
                   "name": "test-customer-1",
                   "type": 1,
                   "parentId": "61430ad8d953fb02806ebd16",
                   "companyId": "61430ad8d953fb02806ebd12",
                   "details": {
                   "type": 0,
                   "address": "",
                   "phone": "",
                   "canBeManagedByAbove": true,
                   "enforce2FA": false,
                   "isSuspended": false,
                   "createdAt": "2021-10-04T11:58:28",
                   "country": "AF",
                   "state": "N/A",
                   "licenseInfo": {
                       "subscriptionType": 2,
                       "isAddon": false,
                       "expiryDate": "2023-03-19T17:21:50",
                       "usedSlots": 0,
                       "totalSlots": 50,
                       "licenseKey": "ARS4THG",
                       "additionalLicenses": [
                           {
                               "isAddon": false,
                               "expiryDate": "2023-03-19T17:21:50",
                               "usedSlots": 0,
                               "totalSlots": 50,
                               "licenseKey": "IDTGNIV"
                           },
                           {
                               "isAddon": false,
                               "expiryDate": "2024-05-19T17:21:50"
                               "usedSlots": 0,
                               "totalSlots": 50
                               "licenseKey": "6AZJ5EL",
                           }
                       ]
                   }
               }
           ]
       }
  }