Sign in
Rtce Topics (rtce/v1)

List of Rtce Topics

General Availability

Retrieve a sorted, filtered, paginated list of all rtce topics.

get/rtce/v1/rtce-topics

Query parameters

spec.cloudstring

Filter a collection by a string search

Filter the results by exact match for spec.cloud.

spec.regionstring

Filter a collection by a string search

Filter the results by exact match for spec.region.

environmentstring required

Filter a collection by a string search

Filter the results by exact match for environment.

spec.kafka_clusterstring required

Filter a collection by a string search

Filter the results by exact match for spec.kafka_cluster.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Rtce Topic.

api_version'rtce/v1' required

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

kind'RtceTopicList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/rtce/v1/rtce-topics",
    "last": "https://api.confluent.cloud/rtce/v1/rtce-topics?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/rtce/v1/rtce-topics?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/rtce/v1/rtce-topics?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "metadata": {
        "self": "https://api.confluent.cloud/rtce/v1/rtce-topics/rt-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-12345/topic=tt-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "spec": {
        "cloud": "AWS",
        "region": "us-west-2",
        "topic_name": "orders_topic",
        "description": "Customer orders table for real-time analytics",
        "environment": {
          "id": "env-00000",
          "related": "https://api.confluent.cloud/org/v2/environments/env-00000",
          "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
        },
        "kafka_cluster": {
          "id": "lkc-00000",
          "related": "https://api.confluent.cloud/cmk/v2/clusters/lkc-00000",
          "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000"
        }
      },
      "status": {
        "phase": "PROVISIONING",
        "error_message": "Failed to provision table: insufficient resources"
      }
    }
  ]
}

Changes

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