---
title: "GET /list-collectors"
method: GET
path: "/list-collectors"
---

# GET /list-collectors

`GET /list-collectors`

Retrieves a list of all the installed collectors.

## Query parameters

- `maxResults` integer
- `nextToken` string

## Response `200`

Success

- ListCollectorsResponse
  - `Collectors` Collector[] — The list of all the installed collectors.
    - `collectorHealth` 'COLLECTOR_HEALTHY' | 'COLLECTOR_UNHEALTHY' — Indicates the health of a collector.
    - `collectorId` string — The ID of the collector.
    - `collectorVersion` string — Current version of the collector that is running in the environment that you specify.
    - `configurationSummary` object — Summary of the collector configuration.
      - `ipAddressBasedRemoteInfoList` IPAddressBasedRemoteInfo[] — IP address based configurations.
        - `authType` 'NTLM' | 'SSH' | 'CERT' — The type of authorization.
        - `ipAddressConfigurationTimeStamp` string — The time stamp of the configuration.
        - `osType` 'LINUX' | 'WINDOWS' — The type of the operating system.
      - `pipelineInfoList` PipelineInfo[] — The list of pipeline info configurations.
        - `pipelineConfigurationTimeStamp` string — The time when the pipeline info was configured.
        - `pipelineType` 'AZURE_DEVOPS' — The type of pipeline.
      - `remoteSourceCodeAnalysisServerInfo` object — Info about the remote server source code configuration.
        - `remoteSourceCodeAnalysisServerConfigurationTimestamp` string — The time when the remote source code server was configured.
      - `vcenterBasedRemoteInfoList` VcenterBasedRemoteInfo[] — The list of vCenter configurations.
        - `osType` 'LINUX' | 'WINDOWS' — The type of the operating system.
        - `vcenterConfigurationTimeStamp` string — The time when the remote server based on vCenter was last configured.
      - `versionControlInfoList` VersionControlInfo[] — The list of the version control configurations.
        - `versionControlConfigurationTimeStamp` string — The time when the version control system was last configured.
        - `versionControlType` 'GITHUB' | 'GITHUB_ENTERPRISE' | 'AZURE_DEVOPS_GIT' — The type of version control.
    - `hostName` string — Hostname of the server that is hosting the collector.
    - `ipAddress` string — IP address of the server that is hosting the collector.
    - `lastActivityTimeStamp` string — Time when the collector last pinged the service.
    - `registeredTimeStamp` string — Time when the collector registered with the service.
  - `nextToken` string — The token you use to retrieve the next set of results, or null if there are no more results.

## Other responses

- `480` — AccessDeniedException
- `481` — ThrottlingException
- `482` — ValidationException
- `483` — InternalServerException

---

[API](https://skmtc.net/aws/apis/migrationhubstrategy.md) · [All operations](https://skmtc.net/aws/apis/migrationhubstrategy/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/migrationhubstrategy/versions/5fde79aed042/schema)