Sign in
Msgs

Topic Describe

Changed on

Show information about the given topic

post/api/v1.msgs.topic.describe

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Request body

namespacestring nullable
topicstring required
consistency'strong' | 'weak'

Consistency level for reads.

Strong consistency (also known as linearizability) guarantees that a read will see all previous writes. Weak consistency allows stale reads, but can save one or more round trip to the leader.

Example request

{
  "namespace": "some_namespace",
  "topic": "some_topic_name"
}

Response

idstring required

The unique internal ID of this topic

This can useful for debugging

namestring required

Example response

{
  "id": "topic_06etngr201xwv7qj08mt4cs03w",
  "name": "some_topic_name"
}

Changes