getNetworkInventoryItems
This method returns network inventory items.
Important
This method has been updated to version 1.1. For information applicable to version 1.0, refer to this section.
Parameters
Parameter | Type | Optional | Description |
---|---|---|---|
| String | Yes | The ID of the target company or group. If not specified, the default value applies. Default value: the ID of the company that the API key used to make the request belongs to. |
| Object | Yes | The filters you want to use when querying the endpoints list. You can find a full list of available filters and instructions on how to use them, under Available Filters. |
| Number | Yes | The results page number. Default page number is 1. |
| Number | Yes | Number of items per page to be returned. Possible values: Default value: |
| Object | Yes | Use this set of options that to control what information is included in the request. For more information, refer to Available Options. |
Available Options
You can use the options
parameter to control what data is returned in the response.
Section | Subsection | Optional | Options |
---|---|---|---|
| Yes |
| |
| Yes |
|
Available filters
Section | Subsection | Filtering Options |
---|---|---|
|
| |
| management |
|
|
| |
|
|
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 page currently displayed.pagesCount
- the total number of pages. This information is displayed only on the first page of results.perPage
- the total number of items returned per page.total
- the total number of items. This information is displayed only on the first page of results.hasMoreRecords
- a boolean that Indicates if more pages of results are available.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 for1
- Companies,5
- Computers,6
- Virtual Machines,7
- EC2 Instances and16
- 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 |
---|---|
|
|
Example
Request:
{ "params": { "parentId": "23b19c39b1a43d89367b32ce", "page": 1, "perPage": 1, "filters": { "type": { "computers": true }, "depth": { "allItemsRecursively": true } }, "options": { "companies": { "returnAllProducts": true } "endpoints": { "returnProductOutdated": true, "includeScanLogs": true } } }, "jsonrpc": "2.0", "method": "getNetworkInventoryItems", "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b" }
Response:
{ "result": { "total": 8, "page": 1, "perPage": 30, "pagesCount": 1, "hasMoreRecords": true, "items": [ { "id": "64b51d5266333579d804e696", "name": "MSPPartner01", "type": 1, "parentId": "64b503c21ecee42e130a7bc7", "companyId": "64b503c21ecee42e130a7bc4", "details": { "type": 0, "address": "", "phone": "", "industry": 0, "canBeManagedByAbove": true, "enforce2FA": true, "skip2FAPeriod": 0, "isSuspended": false, "createdAt": "2023-07-17T10:52:02", "country": "N/A", "state": "N/A", "contactPerson": { "email": "[email protected]", "fullName": "", "phoneNumber": "", "companyRole": "" }, "licenseInfo": { "isAddon": false, "expiryDate": "2025-04-22T00:00:00", "usedSlots": 2, "reservedSlots": 0, "totalSlots": null, "manageExchange": false, "manageEncryption": false, "manageRemoteEnginesScanning": false, "manageHyperDetect": true, "manageSandboxAnalyzer": true, "managePatchManagement": false, "manageEventCorrelator": true, "manageEmailSecurity": false, "manageMobileSecurity": false, "manageContainerProtection": false, "manageIntegrityMonitoring": false, "assignedProtectionModel": "mspSecureExtra", "additionalProtectionModels": [ "aLaCarte", "mspSecure", "mspSecurePlus", "mspSecureExtra" ], "assignedProductType": 0, "additionalProductTypes": [ 0 ], "ownUse": { "manageXDRIdentityProviders": true, "manageXDRProductivityApps": true, "manageXDRNetwork": false, "manageXDRCloudWorkloads": false, "manageRemoteEnginesScanning": false, "manageContainerProtection": false, "manageHyperDetect": true, "manageSandboxAnalyzer": true, "manageEventCorrelator": true }, "resell": { "manageXDRResell": true, "manageRemoteEnginesScanningResell": false, "manageContainerProtectionResell": false, "manageHyperDetectResell": true, "manageSandboxAnalyzerResell": true, "manageEventCorrelatorResell": true }, "licensedServices": { "mdrServiceFlavor": 1, "mdrServiceStatus": 3, "mdrStatusStartDate": "2023-07-17T10:52:03", "mdrServiceResell": true }, "subscriptionType": 3 } } }, { "id": "64b503c21ecee42e130a7bc9", "name": "Custom Groups", "type": 4, "parentId": "64b503c21ecee42e130a7bc4", "companyId": "64b503c21ecee42e130a7bc4" }, { "id": "64b51d5366333579d804e69c", "name": "Custom Groups", "type": 4, "parentId": "64b51d5266333579d804e696", "companyId": "64b51d5266333579d804e696" }, { "id": "64b76496cc33ea14e43c3c2b", "name": "gfdsg00:16:3e:28:ee:fe", "type": 5, "parentId": "64b51d5366333579d804e69c", "companyId": "64b51d5266333579d804e696", "details": { "label": "", "fqdn": "t4x03.mqdhn.dsd.ro", "groupId": "64b51d5366333579d804e69c", "isManaged": true, "machineType": 1, "operatingSystemVersion": "Windows 7 Professional", "ip": "136.61.135.44", "macs": [ "00:16:3e:28:ee:fe" ], "ssid": "", "managedWithBest": true, "policy": { "id": "64b76bed92f0176fa203b64c", "name": "New Policy", "applied": false }, "productOutdated": false }, "lastSuccessfulScan": { "name": "tXoRyyCSLn", "date": "2023-07-19T04:18:58+00:00" } }, { "id": "64b51ecd4eea172c5b3f92d1", "name": "string00:16:3e:2c:45:da", "type": 5, "parentId": "64b51d5366333579d804e69c", "companyId": "64b51d5266333579d804e696", "details": { "label": "", "fqdn": "fcm0s.oyzqh.dsd.ro", "groupId": "64b51d5366333579d804e69c", "isManaged": true, "machineType": 1, "operatingSystemVersion": "Windows 7 Professional", "ip": "44.215.154.49", "macs": [ "00:16:3e:2c:45:da" ], "ssid": "", "managedWithBest": true, "policy": { "id": "64b76bed92f0176fa203b64c", "name": "New Policy", "applied": false }, "productOutdated": false }, "lastSuccessfulScan": { "name": "lJeA5kuIWK", "date": "2023-07-17T10:58:05+00:00" } }, { "id": "64b7625d3c11463ef77e5d6d", "name": "string00:16:3e:7f:d3:2e", "type": 5, "parentId": "64b503c21ecee42e130a7bc9", "companyId": "64b503c21ecee42e130a7bc4", "details": { "label": "", "fqdn": "s0lc5.wkorh.dsd.ro", "groupId": "64b503c21ecee42e130a7bc9", "isManaged": true, "machineType": 1, "operatingSystemVersion": "Windows 7 Professional", "ip": "231.180.244.114", "macs": [ "00:16:3e:7f:d3:2e" ], "ssid": "", "managedWithBest": true, "policy": { "id": "64b76bed92f0176fa203b64c", "name": "New Policy", "applied": false }, "productOutdated": false }, "lastSuccessfulScan": { "name": "72OHI5dnIH", "date": "2023-07-19T04:09:29+00:00" } }, { "id": "64b503c21ecee42e130a7bca", "name": "Deleted", "type": 4, "parentId": "64b503c21ecee42e130a7bc4", "companyId": "64b503c21ecee42e130a7bc4" }, { "id": "64b51d5366333579d804e69d", "name": "Deleted", "type": 4, "parentId": "64b51d5266333579d804e696", "companyId": "64b51d5266333579d804e696" } ] }, "jsonrpc": "2.0", "id": "5986", "error": null }
{ "result": { "page": 2, "perPage": 3, "hasMoreRecords": true, "items": [ "...": "..." ] }
Version 1.0
Parameters
Parameter | Type | Optional | Description |
---|---|---|---|
| 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. |
| 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. |
| Number | Yes | The results page number. Default page number is 1. |
| Number | Yes | Number of items per page to be returned. The upper limit is 100 items per page. Default value: 30 items per page. |
| 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 |
---|---|---|
|
| |
|
|
Available filters
Section | Subsection | Filtering Options |
---|---|---|
|
| |
| management |
|
|
| |
|
|
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 pagepagesCount
- the total number of pagesperPage
- the total number of items returned per pagetotal
- the total number of itemsitems
- 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 for1
- Companies,5
- Computers,6
- Virtual Machines,7
- EC2 Instances and16
- 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 |
---|---|
|
|
Example
Request:
{ "params": { "parentId": "23b19c39b1a43d89367b32ce", "page": 1, "perPage": 1, "filters": { "type": { "computers": true }, "depth": { "allItemsRecursively": true } }, "options": { "companies": { "returnAllProducts": true } "endpoints": { "returnProductOutdated": true, "includeScanLogs": true } } }, "jsonrpc": "2.0", "method": "getNetworkInventoryItems", "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b" }
Response:
{ "result": { "total": 8, "page": 1, "perPage": 30, "pagesCount": 1, "items": [ { "id": "64b51d5266333579d804e696", "name": "MSPPartner01", "type": 1, "parentId": "64b503c21ecee42e130a7bc7", "companyId": "64b503c21ecee42e130a7bc4", "details": { "type": 0, "address": "", "phone": "", "industry": 0, "canBeManagedByAbove": true, "enforce2FA": true, "skip2FAPeriod": 0, "isSuspended": false, "createdAt": "2023-07-17T10:52:02", "country": "N/A", "state": "N/A", "contactPerson": { "email": "[email protected]", "fullName": "", "phoneNumber": "", "companyRole": "" }, "licenseInfo": { "isAddon": false, "expiryDate": "2025-04-22T00:00:00", "usedSlots": 2, "reservedSlots": 0, "totalSlots": null, "manageExchange": false, "manageEncryption": false, "manageRemoteEnginesScanning": false, "manageHyperDetect": true, "manageSandboxAnalyzer": true, "managePatchManagement": false, "manageEventCorrelator": true, "manageEmailSecurity": false, "manageMobileSecurity": false, "manageContainerProtection": false, "manageIntegrityMonitoring": false, "assignedProtectionModel": "mspSecureExtra", "additionalProtectionModels": [ "aLaCarte", "mspSecure", "mspSecurePlus", "mspSecureExtra" ], "assignedProductType": 0, "additionalProductTypes": [ 0 ], "ownUse": { "manageXDRIdentityProviders": true, "manageXDRProductivityApps": true, "manageXDRNetwork": false, "manageXDRCloudWorkloads": false, "manageRemoteEnginesScanning": false, "manageContainerProtection": false, "manageHyperDetect": true, "manageSandboxAnalyzer": true, "manageEventCorrelator": true }, "resell": { "manageXDRResell": true, "manageRemoteEnginesScanningResell": false, "manageContainerProtectionResell": false, "manageHyperDetectResell": true, "manageSandboxAnalyzerResell": true, "manageEventCorrelatorResell": true }, "licensedServices": { "mdrServiceFlavor": 1, "mdrServiceStatus": 3, "mdrStatusStartDate": "2023-07-17T10:52:03", "mdrServiceResell": true }, "subscriptionType": 3 } } }, { "id": "64b503c21ecee42e130a7bc9", "name": "Custom Groups", "type": 4, "parentId": "64b503c21ecee42e130a7bc4", "companyId": "64b503c21ecee42e130a7bc4" }, { "id": "64b51d5366333579d804e69c", "name": "Custom Groups", "type": 4, "parentId": "64b51d5266333579d804e696", "companyId": "64b51d5266333579d804e696" }, { "id": "64b76496cc33ea14e43c3c2b", "name": "gfdsg00:16:3e:28:ee:fe", "type": 5, "parentId": "64b51d5366333579d804e69c", "companyId": "64b51d5266333579d804e696", "details": { "label": "", "fqdn": "t4x03.mqdhn.dsd.ro", "groupId": "64b51d5366333579d804e69c", "isManaged": true, "machineType": 1, "operatingSystemVersion": "Windows 7 Professional", "ip": "136.61.135.44", "macs": [ "00:16:3e:28:ee:fe" ], "ssid": "", "managedWithBest": true, "policy": { "id": "64b76bed92f0176fa203b64c", "name": "New Policy", "applied": false }, "productOutdated": false }, "lastSuccessfulScan": { "name": "tXoRyyCSLn", "date": "2023-07-19T04:18:58+00:00" } }, { "id": "64b51ecd4eea172c5b3f92d1", "name": "string00:16:3e:2c:45:da", "type": 5, "parentId": "64b51d5366333579d804e69c", "companyId": "64b51d5266333579d804e696", "details": { "label": "", "fqdn": "fcm0s.oyzqh.dsd.ro", "groupId": "64b51d5366333579d804e69c", "isManaged": true, "machineType": 1, "operatingSystemVersion": "Windows 7 Professional", "ip": "44.215.154.49", "macs": [ "00:16:3e:2c:45:da" ], "ssid": "", "managedWithBest": true, "policy": { "id": "64b76bed92f0176fa203b64c", "name": "New Policy", "applied": false }, "productOutdated": false }, "lastSuccessfulScan": { "name": "lJeA5kuIWK", "date": "2023-07-17T10:58:05+00:00" } }, { "id": "64b7625d3c11463ef77e5d6d", "name": "string00:16:3e:7f:d3:2e", "type": 5, "parentId": "64b503c21ecee42e130a7bc9", "companyId": "64b503c21ecee42e130a7bc4", "details": { "label": "", "fqdn": "s0lc5.wkorh.dsd.ro", "groupId": "64b503c21ecee42e130a7bc9", "isManaged": true, "machineType": 1, "operatingSystemVersion": "Windows 7 Professional", "ip": "231.180.244.114", "macs": [ "00:16:3e:7f:d3:2e" ], "ssid": "", "managedWithBest": true, "policy": { "id": "64b76bed92f0176fa203b64c", "name": "New Policy", "applied": false }, "productOutdated": false }, "lastSuccessfulScan": { "name": "72OHI5dnIH", "date": "2023-07-19T04:09:29+00:00" } }, { "id": "64b503c21ecee42e130a7bca", "name": "Deleted", "type": 4, "parentId": "64b503c21ecee42e130a7bc4", "companyId": "64b503c21ecee42e130a7bc4" }, { "id": "64b51d5366333579d804e69d", "name": "Deleted", "type": 4, "parentId": "64b51d5266333579d804e696", "companyId": "64b51d5266333579d804e696" } ] }, "jsonrpc": "2.0", "id": "5986", "error": null }