Topics

A Topic is a messaging channel or event stream managed by a Messaging Service. Topics hold messages with defined schemas and configurations for partitioning, retention, and replication.

Entity schema follows the OpenMetadata Standard.

Entity Hierarchy

Topics belong to a Messaging Service:

MessagingService
└── Topic (this page)

Fully Qualified Name

The FQN format for a topic is:

service.topicName

For example: sample_kafka.address_book

API Endpoints

Method	Endpoint	Description
`PUT`	`/v1/topics`	Create or update a topic
`POST`	`/v1/topics`	Create a topic (POST variant)
`GET`	`/v1/topics`	List topics
`GET`	`/v1/topics/{id}`	Get by ID
`GET`	`/v1/topics/name/{fqn}`	Get by FQN
`PATCH`	`/v1/topics/{id}`	Update by ID
`PATCH`	`/v1/topics/name/{fqn}`	Update by name
`DELETE`	`/v1/topics/{id}`	Delete by ID
`DELETE`	`/v1/topics/name/{fqn}`	Delete by name
`PUT`	`/v1/topics/restore`	Restore soft-deleted topic
`GET`	`/v1/topics/{id}/versions`	List versions
`GET`	`/v1/topics/{id}/versions/{version}`	Get specific version
`PUT`	`/v1/topics/{id}/followers`	Add follower
`DELETE`	`/v1/topics/{id}/followers/{userId}`	Remove follower
`PUT`	`/v1/topics/{id}/vote`	Add/update vote

Table Versions

Create a Topic

​Topics

​Entity Hierarchy

​Fully Qualified Name

​API Endpoints

Topics

Entity Hierarchy

Fully Qualified Name

API Endpoints