GET
/
api
/
utm-network-scans
/
search-by-filters
[
  {
    "id": 123,
    "assetIp": "<string>",
    "assetAddresses": "<string>",
    "assetMac": "<string>",
    "assetOs": "<string>",
    "assetOsArch": "<string>",
    "assetOsMajorVersion": "<string>",
    "assetOsMinorVersion": "<string>",
    "assetOsPlatform": "<string>",
    "assetOsVersion": "<string>",
    "assetName": "<string>",
    "assetAliases": "<string>",
    "assetAlias": "<string>",
    "serverName": "<string>",
    "assetAlive": true,
    "registeredMode": "CUSTOM",
    "assetStatus": "NEW",
    "assetSeverityMetric": 123,
    "assetType": {
      "id": 123,
      "typeName": "<string>"
    },
    "assetNotes": "<string>",
    "discoveredAt": "2023-11-07T05:31:56Z",
    "modifiedAt": "2023-11-07T05:31:56Z",
    "metrics": {},
    "ports": [
      {
        "port": 123,
        "tcp": "<string>",
        "udp": "<string>"
      }
    ],
    "group": {
      "id": 123,
      "groupName": "<string>",
      "groupDescription": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "metrics": [
        {
          "id": "<string>",
          "assetName": "<string>",
          "metric": "<string>",
          "amount": 123
        }
      ],
      "assets": [
        {
          "id": 123,
          "assetIp": "<string>",
          "assetAddresses": "<string>",
          "assetMac": "<string>",
          "assetOs": "<string>",
          "assetOsArch": "<string>",
          "assetOsMajorVersion": "<string>",
          "assetOsMinorVersion": "<string>",
          "assetOsPlatform": "<string>",
          "assetOsVersion": "<string>",
          "assetName": "<string>",
          "assetAliases": "<string>",
          "assetAlias": "<string>",
          "assetAlive": true,
          "assetStatus": "NEW",
          "assetSeverityMetric": 123,
          "discoveredAt": "2023-11-07T05:31:56Z",
          "modifiedAt": "2023-11-07T05:31:56Z",
          "assetNotes": "<string>",
          "serverName": "<string>",
          "groupId": 123,
          "registeredMode": "CUSTOM",
          "isAgent": true,
          "registerIp": "<string>",
          "updateLevel": "DATASOURCE",
          "assetType": {
            "id": 123,
            "typeName": "<string>"
          },
          "ports": [
            {
              "id": 123,
              "scanId": 123,
              "port": 123,
              "tcp": "<string>",
              "udp": "<string>"
            }
          ],
          "metrics": [
            {
              "id": "<string>",
              "assetName": "<string>",
              "metric": "<string>",
              "amount": 123
            }
          ],
          "dataInputList": [
            {
              "id": "<string>",
              "source": "<string>",
              "dataType": "<string>",
              "timestamp": 123,
              "median": 123,
              "down": true
            }
          ],
          "assetGroup": {},
          "uuid": 123
        }
      ],
      "collectors": [
        {
          "id": 123,
          "status": "<string>",
          "collectorKey": "<string>",
          "ip": "<string>",
          "hostname": "<string>",
          "version": "<string>",
          "module": "<string>",
          "lastSeen": "2023-11-07T05:31:56Z",
          "groupId": 123,
          "assetGroup": {},
          "active": true
        }
      ],
      "type": "<string>"
    },
    "dataInputList": [
      {
        "id": "<string>",
        "source": "<string>",
        "dataType": "<string>",
        "timestamp": 123,
        "median": 123,
        "down": true
      }
    ],
    "agent": true
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
Utm-Internal-Key
string
header
required

Query Parameters

​
assetIpMacName
string
​
os
string[]
​
alive
boolean[]
​
status
enum<string>[]
Available options:
NEW,
CHECK,
MISSING
​
type
string[]
​
alias
string[]
​
probe
string[]
​
openPorts
integer[]
​
groups
string[]
​
discoveredInitDate
string
​
discoveredEndDate
string
​
registeredMode
enum<string>
Available options:
CUSTOM,
DISCOVERED,
DYNAMIC
​
agent
boolean[]
​
osPlatform
string[]
​
page
integer
default:0

Zero-based page index (0..N)

Required range: x >= 0
​
size
integer
default:20

The size of the page to be returned

Required range: x >= 1
​
sort
string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

200 - */*
OK
​
id
integer
​
assetIp
string
​
assetAddresses
string
​
assetMac
string
​
assetOs
string
​
assetOsArch
string
​
assetOsMajorVersion
string
​
assetOsMinorVersion
string
​
assetOsPlatform
string
​
assetOsVersion
string
​
assetName
string
​
assetAliases
string
​
assetAlias
string
​
serverName
string
​
assetAlive
boolean
​
registeredMode
enum<string>
Available options:
CUSTOM,
DISCOVERED,
DYNAMIC
​
assetStatus
enum<string>
Available options:
NEW,
CHECK,
MISSING
​
assetSeverityMetric
number
​
assetType
object
​
assetNotes
string
​
discoveredAt
string
​
modifiedAt
string
​
metrics
object
​
ports
object[]
​
group
object
​
dataInputList
object[]
​
agent
boolean