---
title: "Get paginated list of OT Collectors"
method: POST
path: "/v1/otCollectors"
tags: ["otCollectorManagementExternal"]
---

# Get paginated list of OT Collectors

`POST /v1/otCollectors`

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

## Request body

- PaginatedOTCollectorsRequest
  - `search` string — search by collector id or free text search on collector properties.
  - `filters` object — parameter which is used for filtering.
    - `tags` array[] — tags associated with the OT collector
      - OtTag[]
        - `key` string, required — key of the given tag.
        - `values` string[], required — values of the given tag.
    - `os` string, nullable — Name of the Operating System.
    - `collectorVersionRange` VersionRange — Version range for otCollector.
      - `minVersion` string — Minimum version of otCollector.
      - `maxVersion` string — Maximum version of the collector.
      - `rangeType` string — Specifies how filtering should be applied when `minVersion` and `maxVersion` are defined. - `Within`: Filtering includes the specified range. - `Outside`: Filtering excludes the specified range. By default, filtering includes the specified range.
    - `alive` boolean, nullable — alive Status of the OT Collector based on heartbeat.
    - `isRemotelyManaged` boolean, nullable — Management Status of the OT Collector based on if it is remotely or locally managed.
    - `isUpgradeAvailable` boolean, nullable — upgrade availability status of the OT Collector.
    - `hasNoSourceTemplateLinked` boolean, nullable — whether the remotely managed OT Collector has no source template linked.
    - `healthStatus` string[] — Filter by one or more health statuses of the OT Collector.
    - `hasNoData` boolean, nullable — Filter OT Collectors by no-data status. When true, returns only collectors with no data. When false, returns only collectors that have data.
  - `sortBy` string — parameter which is used for sorting.
  - `next` string — parameter which is used for fetching next set of results.
  - `limit` integer — parameter which is used for limiting number of otCollectors on a page.
  - `includeCount` boolean, nullable — count of filtered otCollectors.

## Response `200`

A list of paginated OT Collectors.

- PaginatedOTCollectorsResponse
  - `data` OTCollector[], required — paginated list of OT Collectors.
    - `id` string, required — Unique identifier of the OT Collector.
    - `name` string, required — Name of the OT Collector.
    - `version` object, required — Version information of the OT Collector.
      - `currentVersion` string, required — Current version of the OT Collector.
      - `latestAvailableVersion` string — Latest available version of the OT Collector.
    - `category` string — Category of the OT Collector.
    - `description` string — Description of the OT Collector.
    - `tags` object — Tags associated with the OT Collector.
    - `healthIncidentsTracker` object — Health incident information.
      - `errorsCount` integer — Number of errors associated with the OT Collector.
      - `warningsCount` integer — Number of warnings associated with the OT Collector.
    - `ephemeral` boolean — Ephemeral Status of the OT Collector.
    - `alive` boolean — Alive Status of the OT Collector based on heartbeat.
    - `isRemotelyManaged` boolean — Management Status of the OT Collector based on if it is remotely or locally managed.
    - `effectiveConfig` object — Config map that includes Base 64 Encoded Effective Configuration Yaml of the Remotely managed OT Collector.
    - `systemInfo` object, required — System information of the OT Collector.
      - `hostName` string — Host name of the OT Collector.
      - `hostOsName` string — Host OS name of the OT Collector.
      - `hostOsVersion` string — Host OS version of the OT Collector.
      - `hostIpAddress` string — Host IP address of the OT Collector.
      - `hostEnv` string — Host environment of the OT Collector.
    - `timeZone` string — timezone of the collector
    - `createdAt` string, date-time, required — Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
    - `createdBy` string, required — Identifier of the user who created the resource.
    - `modifiedAt` string, date-time, required — Last modification timestamp in UTC.
    - `modifiedBy` string, required — Identifier of the user who last modified the resource.
    - `sourceTemplateLinkedCount` integer — Count of the source templates linked to a collector
  - `next` string — next page token.
  - `count` integer — count of otCollectors in response.

## Other responses

- `default` — Operation failed with an error.

---

[API](https://skmtc.net/sumologic/apis/sumo-logic-api.md) · [All operations](https://skmtc.net/sumologic/apis/sumo-logic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumologic/sumo-logic-api/revisions/e4e4c7554890/schema)