GET
/
api
/
collectors-list
{
  "collectors": [
    {
      "id": 123,
      "status": "ONLINE",
      "collectorKey": "<string>",
      "ip": "<string>",
      "hostname": "<string>",
      "version": "<string>",
      "module": "AS_400",
      "lastSeen": "<string>",
      "groupId": "<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>"
      },
      "active": true
    }
  ],
  "total": 123
}

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

pageNumber
integer
pageSize
integer
module
enum<string>
Available options:
AS_400
sortBy
string

Response

200 - */*
OK
collectors
object[]
total
integer