---
title: "Get OT Collectors by name."
method: GET
path: "/v1/otCollectors/otCollectorsByName"
tags: ["otCollectorManagementExternal"]
---

# Get OT Collectors by name.

`GET /v1/otCollectors/otCollectorsByName`

provided list of names, get all OT Collectors with metadata.

## Query parameters

- `names` string[], required

## Response `200`

A list of OT Collectors.

- OTCollectorListResponse
  - `data` OTCollector[], required — 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

## 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)