---
title: "List mirror topics"
method: GET
path: "/kafka/v3/clusters/{cluster_id}/links/-/mirrors"
tags: ["Cluster Linking (v3)"]
---

# List mirror topics

`GET /kafka/v3/clusters/{cluster_id}/links/-/mirrors`

## Request

- Base URL: `https://pkc-00000.region.provider.confluent.cloud`
- URL: `https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/{cluster_id}/links/-/mirrors`
- Auth: one of:
  - HTTP basic
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.confluent.cloud/sts/v1/oauth2/token`

[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

List all mirror topics in the cluster

## Query parameters

- `mirror_status` 'ACTIVE' | 'FAILED' | 'LINK_FAILED' | 'LINK_PAUSED' | 'PAUSED' | 'PENDING_STOPPED' | 'SOURCE_UNAVAILABLE' | 'STOPPED' | 'PENDING_MIRROR' | 'PENDING_SYNCHRONIZE' | 'PENDING_SETUP_FOR_RESTORE' | 'PENDING_RESTORE'

## Response `200`

Metadata of mirror topics

- ListMirrorTopicsResponseDataList
  - `kind` string, required
  - `metadata` ResourceCollectionMetadata, required
    - `self` string, required
    - `next` string, nullable
  - `data` ListMirrorTopicsResponseData[], required
    - `kind` string, required
    - `metadata` ResourceMetadata, required
      - `self` string, required
      - `resource_name` string, nullable
    - `link_name` string, required
    - `mirror_topic_name` string, required
    - `source_topic_name` string, required
    - `num_partitions` integer, required
    - `mirror_lags` MirrorLag[], required
      - `partition` integer, required
      - `lag` integer, required
      - `last_source_fetch_offset` integer, required
    - `mirror_status` 'ACTIVE' | 'FAILED' | 'LINK_FAILED' | 'LINK_PAUSED' | 'PAUSED' | 'PENDING_STOPPED' | 'SOURCE_UNAVAILABLE' | 'STOPPED' | 'PENDING_MIRROR' | 'PENDING_SYNCHRONIZE' | 'PENDING_SETUP_FOR_RESTORE' | 'PENDING_RESTORE', required
    - `mirror_topic_error` string
    - `state_time_ms` integer, required
    - `mirror_state_transition_errors` LinkTaskError[]
      - `error_code` string, required
      - `error_message` string, required

## Other responses

- `400`: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure.
- `401`: Indicates a client authentication error. Kafka authentication failures will contain error code 40101 in the response body.
- `429`: Indicates that a rate limit threshold has been reached, and the client should retry again later.
- `5XX`: A server-side problem that might not be addressable from the client side. Retriable Kafka errors will contain error code 50003 in the response body.

---

[API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) - [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/confluent/apis/confluent-cloud-apis/revisions/018ddeaf203e?raw)