Sign in
Kafka Clusters (usm/v1)

Read a Kafka Cluster

Preview

Make a request to read a kafka cluster.

get/usm/v1/kafka-clusters/{id}

Path parameters

idstring required

The unique identifier for the kafka cluster.

Query parameters

environmentstring required

Filter a collection by a string search

Scope the operation to the given environment.

Response

Kafka Cluster.

api_version'usm/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'KafkaCluster' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring required

A human-readable name for the Confluent Platform Kafka cluster.

confluent_platform_kafka_cluster_idstring required

The unique identifier of the Kafka cluster within the Confluent Platform environment.

cloudstring required

The cloud service provider where the metadata for the Kafka Cluster should be stored.

regionstring required

The home region of the Confluent Platform Kafka cluster where the metadata should be stored.

Example response

{
  "id": "dlz-f3a90de",
  "display_name": "My-Prod-CP-Cluster",
  "confluent_platform_kafka_cluster_id": "4k0R9d1GTS5tI9f4Y2xZ0Q",
  "cloud": "AWS",
  "region": "us-east-1",
  "environment": {
    "id": "env-00000",
    "related": "https://api.confluent.cloud/v2/environments/env-00000",
    "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.