Get Started Free
  • Get Started Free
  • Courses
    • Apache Kafka 101
    • Kafka Connect 101
    • Kafka Streams 101
    • Data Mesh 101
    • ksqlDB 101
    • Inside ksqlDB
    • Spring Framework and Apache Kafka
    • Building Data Pipelines with Apache Kafka and Confluent
    • Event Sourcing and Event Storage with Apache Kafka
    • Kafka Internals
  • Learn
    • Articles
    • Patterns
    • FAQs
    • 100 Days of Code
    • Blog
    • Podcast
    • Confluent Developer Live
  • Build
    • Language Guides
    • Stream Processing Cookbook
    • Demos
  • Community
    • Kafka Summit Conference
    • Meetups & Events
    • Ask the Community
    • Community Catalysts
  • Docs
    • Docs Home
    • Confluent Cloud
    • Confluent Platform
    • Confluent Connectors
    • Tools
    • Clients
Courses
  • Apache Kafka 101
  • Kafka Connect 101
  • Kafka Streams 101
  • Data Mesh 101
  • ksqlDB 101
  • Inside ksqlDB
  • Spring Framework and Apache Kafka
  • Building Data Pipelines with Apache Kafka and Confluent
  • Event Sourcing and Event Storage with Apache Kafka
  • Kafka Internals
Learn
  • Articles
  • Patterns
  • FAQs
  • 100 Days of Code
  • Blog
  • Podcast
  • Confluent Developer Live
Build
  • Language Guides
  • Stream Processing Cookbook
  • Demos
Community
  • Kafka Summit Conference
  • Meetups & Events
  • Ask the Community
  • Community Catalysts
Docs
  • Docs Home
  • Confluent Cloud
  • Confluent Platform
  • Confluent Connectors
  • Tools
  • Clients
Get Started Free
Confluent Documentation
  • Site Filter

CONFLUENT CLI

  • Overview
  • Install and Configure
    • Install Confluent CLI
    • Migrate to Confluent CLI v2
  • Connect to Confluent
    • Connect Confluent CLI to Confluent Cloud
  • Manage Confluent
    • Produce and Consume in Confluent Platform
  • Command Reference
    • Overview
      • confluent admin
        • confluent admin payment
          • confluent admin payment describe
          • confluent admin payment update
        • confluent admin promo
          • confluent admin promo add
          • confluent admin promo list
      • confluent api-key
        • confluent api-key create
        • confluent api-key delete
        • confluent api-key list
        • confluent api-key store
        • confluent api-key update
        • confluent api-key use
      • confluent audit-log
        • confluent audit-log config
          • confluent audit-log config describe
          • confluent audit-log config edit
          • confluent audit-log config update
        • confluent audit-log describe
        • confluent audit-log migrate
          • confluent audit-log migrate config
        • confluent audit-log route
          • confluent audit-log route list
          • confluent audit-log route lookup
      • confluent cloud-signup
      • confluent cluster
        • confluent cluster describe
        • confluent cluster list
        • confluent cluster register
        • confluent cluster unregister
      • confluent completion
      • confluent connect
        • confluent connect cluster
          • confluent connect cluster list
        • confluent connect create
        • confluent connect delete
        • confluent connect describe
        • confluent connect event
          • confluent connect event describe
        • confluent connect list
        • confluent connect pause
        • confluent connect plugin
          • confluent connect plugin describe
          • confluent connect plugin list
        • confluent connect resume
        • confluent connect update
      • confluent context
        • confluent context create
        • confluent context delete
        • confluent context describe
        • confluent context list
        • confluent context update
        • confluent context use
      • confluent environment
        • confluent environment create
        • confluent environment delete
        • confluent environment list
        • confluent environment update
        • confluent environment use
      • confluent iam
        • confluent iam acl
          • confluent iam acl create
          • confluent iam acl delete
          • confluent iam acl list
        • confluent iam rbac
          • confluent iam rbac role
            • confluent iam rbac role describe
            • confluent iam rbac role list
          • confluent iam rbac role-binding
            • confluent iam rbac role-binding create
            • confluent iam rbac role-binding delete
            • confluent iam rbac role-binding list
        • confluent iam service-account
          • confluent iam service-account create
          • confluent iam service-account delete
          • confluent iam service-account list
          • confluent iam service-account update
        • confluent iam user
          • confluent iam user delete
          • confluent iam user describe
          • confluent iam user invitation
            • confluent iam user invitation create
            • confluent iam user invitation list
          • confluent iam user list
      • confluent kafka
        • confluent kafka acl
          • confluent kafka acl create
          • confluent kafka acl delete
          • confluent kafka acl list
        • confluent kafka broker
          • confluent kafka broker delete
          • confluent kafka broker describe
          • confluent kafka broker get-tasks
          • confluent kafka broker list
          • confluent kafka broker update
        • confluent kafka client-config
          • confluent kafka client-config create
            • confluent kafka client-config create clojure
            • confluent kafka client-config create cpp
            • confluent kafka client-config create csharp
            • confluent kafka client-config create go
            • confluent kafka client-config create groovy
            • confluent kafka client-config create java
            • confluent kafka client-config create kotlin
            • confluent kafka client-config create ktor
            • confluent kafka client-config create nodejs
            • confluent kafka client-config create python
            • confluent kafka client-config create restapi
            • confluent kafka client-config create ruby
            • confluent kafka client-config create rust
            • confluent kafka client-config create scala
            • confluent kafka client-config create springboot
        • confluent kafka cluster
          • confluent kafka cluster create
          • confluent kafka cluster delete
          • confluent kafka cluster describe
          • confluent kafka cluster list
          • confluent kafka cluster update
          • confluent kafka cluster use
        • confluent kafka link
          • confluent kafka link create
          • confluent kafka link delete
          • confluent kafka link describe
          • confluent kafka link list
          • confluent kafka link update
        • confluent kafka mirror
          • confluent kafka mirror create
          • confluent kafka mirror describe
          • confluent kafka mirror failover
          • confluent kafka mirror list
          • confluent kafka mirror pause
          • confluent kafka mirror promote
          • confluent kafka mirror resume
        • confluent kafka partition
          • confluent kafka partition describe
          • confluent kafka partition get-reassignments
          • confluent kafka partition list
        • confluent kafka region
          • confluent kafka region list
        • confluent kafka replica
          • confluent kafka replica list
        • confluent kafka topic
          • confluent kafka topic consume
          • confluent kafka topic create
          • confluent kafka topic delete
          • confluent kafka topic describe
          • confluent kafka topic list
          • confluent kafka topic produce
          • confluent kafka topic update
      • confluent ksql
        • confluent ksql app
          • confluent ksql app configure-acls
          • confluent ksql app create
          • confluent ksql app delete
          • confluent ksql app describe
          • confluent ksql app list
        • confluent ksql cluster
          • confluent ksql cluster configure-acls
          • confluent ksql cluster create
          • confluent ksql cluster delete
          • confluent ksql cluster describe
          • confluent ksql cluster list
      • confluent local
        • confluent local current
        • confluent local destroy
        • confluent local services
          • confluent local services connect
            • confluent local services connect connector
              • confluent local services connect connector config
              • confluent local services connect connector list
              • confluent local services connect connector load
              • confluent local services connect connector status
              • confluent local services connect connector unload
            • confluent local services connect log
            • confluent local services connect plugin
              • confluent local services connect plugin list
            • confluent local services connect start
            • confluent local services connect status
            • confluent local services connect stop
            • confluent local services connect top
            • confluent local services connect version
          • confluent local services control-center
            • confluent local services control-center log
            • confluent local services control-center start
            • confluent local services control-center status
            • confluent local services control-center stop
            • confluent local services control-center top
            • confluent local services control-center version
          • confluent local services kafka
            • confluent local services kafka consume
            • confluent local services kafka log
            • confluent local services kafka produce
            • confluent local services kafka start
            • confluent local services kafka status
            • confluent local services kafka stop
            • confluent local services kafka top
            • confluent local services kafka version
          • confluent local services kafka-rest
            • confluent local services kafka-rest log
            • confluent local services kafka-rest start
            • confluent local services kafka-rest status
            • confluent local services kafka-rest stop
            • confluent local services kafka-rest top
            • confluent local services kafka-rest version
          • confluent local services ksql-server
            • confluent local services ksql-server log
            • confluent local services ksql-server start
            • confluent local services ksql-server status
            • confluent local services ksql-server stop
            • confluent local services ksql-server top
            • confluent local services ksql-server version
          • confluent local services list
          • confluent local services schema-registry
            • confluent local services schema-registry acl
            • confluent local services schema-registry log
            • confluent local services schema-registry start
            • confluent local services schema-registry status
            • confluent local services schema-registry stop
            • confluent local services schema-registry top
            • confluent local services schema-registry version
          • confluent local services start
          • confluent local services status
          • confluent local services stop
          • confluent local services top
          • confluent local services zookeeper
            • confluent local services zookeeper log
            • confluent local services zookeeper start
            • confluent local services zookeeper status
            • confluent local services zookeeper stop
            • confluent local services zookeeper top
            • confluent local services zookeeper version
        • confluent local version
      • confluent login
      • confluent logout
      • confluent price
        • confluent price list
      • confluent prompt
      • confluent schema-registry
        • confluent schema-registry cluster
          • confluent schema-registry cluster describe
          • confluent schema-registry cluster enable
          • confluent schema-registry cluster list
          • confluent schema-registry cluster update
        • confluent schema-registry compatibility
          • confluent schema-registry compatibility validate
        • confluent schema-registry config
          • confluent schema-registry config describe
        • confluent schema-registry exporter
          • confluent schema-registry exporter create
          • confluent schema-registry exporter delete
          • confluent schema-registry exporter describe
          • confluent schema-registry exporter get-config
          • confluent schema-registry exporter get-status
          • confluent schema-registry exporter list
          • confluent schema-registry exporter pause
          • confluent schema-registry exporter reset
          • confluent schema-registry exporter resume
          • confluent schema-registry exporter update
        • confluent schema-registry schema
          • confluent schema-registry schema create
          • confluent schema-registry schema delete
          • confluent schema-registry schema describe
        • confluent schema-registry subject
          • confluent schema-registry subject describe
          • confluent schema-registry subject list
          • confluent schema-registry subject update
      • confluent secret
        • confluent secret file
          • confluent secret file add
          • confluent secret file decrypt
          • confluent secret file encrypt
          • confluent secret file remove
          • confluent secret file rotate
          • confluent secret file update
        • confluent secret master-key
          • confluent secret master-key generate
      • confluent service-quota
        • confluent service-quota list
      • confluent shell
      • confluent update
      • confluent version
    • confluent admin
      • confluent admin payment
        • confluent admin payment describe
        • confluent admin payment update
      • confluent admin promo
        • confluent admin promo add
        • confluent admin promo list
    • confluent api-key
      • confluent api-key create
      • confluent api-key delete
      • confluent api-key list
      • confluent api-key store
      • confluent api-key update
      • confluent api-key use
    • confluent audit-log
      • confluent audit-log config
        • confluent audit-log config describe
        • confluent audit-log config edit
        • confluent audit-log config update
      • confluent audit-log describe
      • confluent audit-log migrate
        • confluent audit-log migrate config
      • confluent audit-log route
        • confluent audit-log route list
        • confluent audit-log route lookup
    • confluent cloud-signup
    • confluent cluster
      • confluent cluster describe
      • confluent cluster list
      • confluent cluster register
      • confluent cluster unregister
    • confluent completion
    • confluent connect
      • confluent connect cluster
        • confluent connect cluster list
      • confluent connect create
      • confluent connect delete
      • confluent connect describe
      • confluent connect event
        • confluent connect event describe
      • confluent connect list
      • confluent connect pause
      • confluent connect plugin
        • confluent connect plugin describe
        • confluent connect plugin list
      • confluent connect resume
      • confluent connect update
    • confluent context
      • confluent context create
      • confluent context delete
      • confluent context describe
      • confluent context list
      • confluent context update
      • confluent context use
    • confluent environment
      • confluent environment create
      • confluent environment delete
      • confluent environment list
      • confluent environment update
      • confluent environment use
    • confluent iam
      • confluent iam acl
        • confluent iam acl create
        • confluent iam acl delete
        • confluent iam acl list
      • confluent iam rbac
        • confluent iam rbac role
          • confluent iam rbac role describe
          • confluent iam rbac role list
        • confluent iam rbac role-binding
          • confluent iam rbac role-binding create
          • confluent iam rbac role-binding delete
          • confluent iam rbac role-binding list
      • confluent iam service-account
        • confluent iam service-account create
        • confluent iam service-account delete
        • confluent iam service-account list
        • confluent iam service-account update
      • confluent iam user
        • confluent iam user delete
        • confluent iam user describe
        • confluent iam user invitation
          • confluent iam user invitation create
          • confluent iam user invitation list
        • confluent iam user list
    • confluent kafka
      • confluent kafka acl
        • confluent kafka acl create
        • confluent kafka acl delete
        • confluent kafka acl list
      • confluent kafka broker
        • confluent kafka broker delete
        • confluent kafka broker describe
        • confluent kafka broker get-tasks
        • confluent kafka broker list
        • confluent kafka broker update
      • confluent kafka client-config
        • confluent kafka client-config create
          • confluent kafka client-config create clojure
          • confluent kafka client-config create cpp
          • confluent kafka client-config create csharp
          • confluent kafka client-config create go
          • confluent kafka client-config create groovy
          • confluent kafka client-config create java
          • confluent kafka client-config create kotlin
          • confluent kafka client-config create ktor
          • confluent kafka client-config create nodejs
          • confluent kafka client-config create python
          • confluent kafka client-config create restapi
          • confluent kafka client-config create ruby
          • confluent kafka client-config create rust
          • confluent kafka client-config create scala
          • confluent kafka client-config create springboot
      • confluent kafka cluster
        • confluent kafka cluster create
        • confluent kafka cluster delete
        • confluent kafka cluster describe
        • confluent kafka cluster list
        • confluent kafka cluster update
        • confluent kafka cluster use
      • confluent kafka link
        • confluent kafka link create
        • confluent kafka link delete
        • confluent kafka link describe
        • confluent kafka link list
        • confluent kafka link update
      • confluent kafka mirror
        • confluent kafka mirror create
        • confluent kafka mirror describe
        • confluent kafka mirror failover
        • confluent kafka mirror list
        • confluent kafka mirror pause
        • confluent kafka mirror promote
        • confluent kafka mirror resume
      • confluent kafka partition
        • confluent kafka partition describe
        • confluent kafka partition get-reassignments
        • confluent kafka partition list
      • confluent kafka region
        • confluent kafka region list
      • confluent kafka replica
        • confluent kafka replica list
      • confluent kafka topic
        • confluent kafka topic consume
        • confluent kafka topic create
        • confluent kafka topic delete
        • confluent kafka topic describe
        • confluent kafka topic list
        • confluent kafka topic produce
        • confluent kafka topic update
    • confluent ksql
      • confluent ksql app
        • confluent ksql app configure-acls
        • confluent ksql app create
        • confluent ksql app delete
        • confluent ksql app describe
        • confluent ksql app list
      • confluent ksql cluster
        • confluent ksql cluster configure-acls
        • confluent ksql cluster create
        • confluent ksql cluster delete
        • confluent ksql cluster describe
        • confluent ksql cluster list
    • confluent local
      • confluent local current
      • confluent local destroy
      • confluent local services
        • confluent local services connect
          • confluent local services connect connector
            • confluent local services connect connector config
            • confluent local services connect connector list
            • confluent local services connect connector load
            • confluent local services connect connector status
            • confluent local services connect connector unload
          • confluent local services connect log
          • confluent local services connect plugin
            • confluent local services connect plugin list
          • confluent local services connect start
          • confluent local services connect status
          • confluent local services connect stop
          • confluent local services connect top
          • confluent local services connect version
        • confluent local services control-center
          • confluent local services control-center log
          • confluent local services control-center start
          • confluent local services control-center status
          • confluent local services control-center stop
          • confluent local services control-center top
          • confluent local services control-center version
        • confluent local services kafka
          • confluent local services kafka consume
          • confluent local services kafka log
          • confluent local services kafka produce
          • confluent local services kafka start
          • confluent local services kafka status
          • confluent local services kafka stop
          • confluent local services kafka top
          • confluent local services kafka version
        • confluent local services kafka-rest
          • confluent local services kafka-rest log
          • confluent local services kafka-rest start
          • confluent local services kafka-rest status
          • confluent local services kafka-rest stop
          • confluent local services kafka-rest top
          • confluent local services kafka-rest version
        • confluent local services ksql-server
          • confluent local services ksql-server log
          • confluent local services ksql-server start
          • confluent local services ksql-server status
          • confluent local services ksql-server stop
          • confluent local services ksql-server top
          • confluent local services ksql-server version
        • confluent local services list
        • confluent local services schema-registry
          • confluent local services schema-registry acl
          • confluent local services schema-registry log
          • confluent local services schema-registry start
          • confluent local services schema-registry status
          • confluent local services schema-registry stop
          • confluent local services schema-registry top
          • confluent local services schema-registry version
        • confluent local services start
        • confluent local services status
        • confluent local services stop
        • confluent local services top
        • confluent local services zookeeper
          • confluent local services zookeeper log
          • confluent local services zookeeper start
          • confluent local services zookeeper status
          • confluent local services zookeeper stop
          • confluent local services zookeeper top
          • confluent local services zookeeper version
      • confluent local version
    • confluent login
    • confluent logout
    • confluent price
      • confluent price list
    • confluent prompt
    • confluent schema-registry
      • confluent schema-registry cluster
        • confluent schema-registry cluster describe
        • confluent schema-registry cluster enable
        • confluent schema-registry cluster list
        • confluent schema-registry cluster update
      • confluent schema-registry compatibility
        • confluent schema-registry compatibility validate
      • confluent schema-registry config
        • confluent schema-registry config describe
      • confluent schema-registry exporter
        • confluent schema-registry exporter create
        • confluent schema-registry exporter delete
        • confluent schema-registry exporter describe
        • confluent schema-registry exporter get-config
        • confluent schema-registry exporter get-status
        • confluent schema-registry exporter list
        • confluent schema-registry exporter pause
        • confluent schema-registry exporter reset
        • confluent schema-registry exporter resume
        • confluent schema-registry exporter update
      • confluent schema-registry schema
        • confluent schema-registry schema create
        • confluent schema-registry schema delete
        • confluent schema-registry schema describe
      • confluent schema-registry subject
        • confluent schema-registry subject describe
        • confluent schema-registry subject list
        • confluent schema-registry subject update
    • confluent secret
      • confluent secret file
        • confluent secret file add
        • confluent secret file decrypt
        • confluent secret file encrypt
        • confluent secret file remove
        • confluent secret file rotate
        • confluent secret file update
      • confluent secret master-key
        • confluent secret master-key generate
    • confluent shell
    • confluent update
    • confluent version
  • Release Notes
  1. Home
  2. Confluent CLI Command Reference
  3. Confluent CLI Command Reference
  4. confluent kafka
  5. confluent kafka link

confluent kafka link describe¶

Description¶

Describe a previously created cluster link.

confluent kafka link describe <link> [flags]

Flags¶

    --cluster string       Kafka cluster ID.
    --environment string   Environment ID.
    --context string       CLI context name.
-o, --output string        Specify the output format as "human", "json", or "yaml". (default "human")
    --url string                Base URL of REST Proxy Endpoint of Kafka Cluster (include /kafka for embedded Rest Proxy). Must set flag or CONFLUENT_REST_URL.
    --ca-cert-path string       Path to a PEM-encoded CA to verify the Confluent REST Proxy.
    --client-cert-path string   Path to client cert to be verified by Confluent REST Proxy, include for mTLS authentication.
    --client-key-path string    Path to client private key, include for mTLS authentication.
    --no-auth                   Include if requests should be made without authentication headers, and user will not be prompted for credentials.
    --prompt                    Bypass use of available login credentials and prompt for Kafka Rest credentials.
    --context string            CLI context name.
-o, --output string             Specify the output format as "human", "json", or "yaml". (default "human")

Global Flags¶

-h, --help            Show help for this command.
-v, --verbose count   Increase verbosity (-v for warn, -vv for info, -vvv for debug, -vvvv for trace).

See Also¶

  • confluent kafka link - Manages inter-cluster links.

Confluent Cloud is a fully-managed Apache Kafka service available on all three major clouds. Try it free today.

Get Started Free
  • Confluent
  • About
  • Careers
  • Contact
  • Professional Services
  • Product
  • Confluent Cloud
  • ksqlDB
  • Developer
  • Free Courses
  • Tutorials
  • Event Streaming Patterns
  • Documentation
  • Blog
  • Podcast
  • Community
  • Forum
  • Meetups
  • Kafka Summit
  • Catalysts
Terms & Conditions Privacy Policy Do Not Sell My Information Modern Slavery Policy Cookie Settings

Copyright © Confluent, Inc. 2014- . Apache, Apache Kafka, Kafka, and associated open source project names are trademarks of the Apache Software Foundation

On this page: