v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

otCollectorManagementExternal

Get paginated list of OT Collectors

Given different filter, search and sort conditions, get list of otCollectors.

post/v1/otCollectors

Request body

searchstring

search by collector id or free text search on collector properties.

sortBystring

parameter which is used for sorting.

nextstring

parameter which is used for fetching next set of results.

limitinteger

parameter which is used for limiting number of otCollectors on a page.

includeCountboolean nullable

count of filtered otCollectors.

Example request

{
  "search": "testAgent",
  "filters": {
    "tags": [
      [
        {
          "key": "region",
          "values": [
            "us2",
            "mum"
          ]
        }
      ],
      [
        {
          "key": "key2",
          "values": [
            "value2"
          ]
        }
      ]
    ],
    "os": "linux",
    "alive": true,
    "isRemotelyManaged": true,
    "isUpgradeAvailable": true,
    "hasNoSourceTemplateLinked": true,
    "healthStatus": [
      "Error",
      "Warning"
    ],
    "hasNoData": true
  },
  "sortBy": "name",
  "next": "token",
  "limit": 30
}

Response

A list of paginated OT Collectors.

nextstring

next page token.

countinteger

count of otCollectors in response.

Example response

{
  "data": [
    {
      "id": "0000000005F5E105",
      "name": "test OT Collector",
      "category": "apache",
      "tags": {
        "team": "app-dev",
        "showIcon": true
      },
      "healthIncidentsTracker": {
        "warningsCount": 1
      },
      "alive": true,
      "isRemotelyManaged": true,
      "effectiveConfig": {
        "00000000000000A3": "ZGVtbyBjb25maWc=",
        "00000000000000D5": "XFVtbfe34tgcvefv="
      },
      "systemInfo": {
        "hostName": "app.test.com",
        "hostOsName": "Linux",
        "hostOsVersion": "5.4.144-69.257.amzn2.x86_64",
        "hostIpAddress": "19.123.24.66",
        "hostEnv": "EKS-1.20.2"
      },
      "timeZone": "UTC",
      "createdAt": "2018-10-16T09:10:00Z",
      "createdBy": "0000000006A5C7A2",
      "modifiedAt": "2018-10-16T09:10:00Z",
      "modifiedBy": "0000000006A5C7A2",
      "sourceTemplateLinkedCount": 1
    }
  ]
}