Getting NetScan Details

Last updated on 14 September, 2023

You can use LogicMonitor REST API v3 to get NetScan details. You must authenticate yourself before making the API request. 

Getting List of NetScan

URI: GET /setting/netscans

ParameterTypeDescription
fieldsStringThe response is filtered to include only the specified fields for each object. You can provide a list of properties separated by a comma. 
Example – /setting/netscans?fields=name,collector
sizeIntegerIndicates the number of results to display. A maximum of 1000 results can be requested in a GET call. By default, a list of 50 NetScans is returned if a value is not provided for this parameter.
Example – /setting/netscans?size=5
offsetIntegerIndicates the number of results to offset the displayed results. By default, the offset is set to 0.
Example – /setting/netscans?offset=2
filterStringThe response is filtered according to the operator and specified value that is, filter=property:value
  • Use an asterisk (*) to match more than one character
  • Use a comma (,) to separate multiple filters
  • You can filter the response based on tagscreatedByhappenedOnmonitorObjectGroupsmonitorObjectNames, or _all field values.
Operators include:
  • Greater than or equals >:
  • Less than or equals <:
  • Greater than >
  • Less than <
  • Does not equal !:
  • Equals :
  • Includes ~
Example – /setting/netscans?filter=note~version

Getting Details of Specific NetScan

URI: GET /setting/netscans/{id}

ParameterTypeDescription
idInteger(Mandatory) The Id of the NetScan whose details you want to get.
In This Article