---
title: "Describe the cluster link"
method: GET
path: "/kafka/v3/clusters/{cluster_id}/links/{link_name}"
tags: ["Cluster Linking (v3)"]
---

# Describe the cluster link

`GET /kafka/v3/clusters/{cluster_id}/links/{link_name}`

## Request

- Base URL: `https://pkc-00000.region.provider.confluent.cloud`
- URL: `https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/{cluster_id}/links/{link_name}`
- 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)

``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead.

## Query parameters

- `include_tasks` boolean

## Response `200`

Single link name and properties

- ListLinksResponseData
  - `kind` string, required
  - `metadata` ResourceMetadata, required
    - `self` string, required
    - `resource_name` string, nullable
  - `source_cluster_id` string, nullable
  - `destination_cluster_id` string, nullable
  - `remote_cluster_id` string, nullable
  - `link_name` string, required
  - `link_id` string
  - `cluster_link_id` string, required
  - `topic_names` string[], required
  - `link_error` string
  - `link_error_message` string, nullable
  - `link_state` string
  - `tasks` LinkTask[], nullable
    - `task_name` string, required
    - `state` string, required
    - `errors` LinkTaskError[], required
      - `error_code` string, required
      - `error_message` string, required
  - `category_counts` LinkCategory[], nullable
    - `state_category` string, required
    - `count` integer, 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)