> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Topics

> Create and manage topics within a messaging service

# 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.

<Info>
  Entity schema follows the [OpenMetadata Standard](https://openmetadatastandards.org/data-assets/messaging/topic/).
</Info>

## Entity Hierarchy

Topics belong to a Messaging Service:

<CodeGroup>
  ```txt Topic theme={null}
  MessagingService
  └── Topic (this page)
  ```
</CodeGroup>

## 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](/v1.12.x/api-reference/data-assets/topics/create)      |
| `POST`   | `/v1/topics`                         | [Create a topic (POST variant)](/v1.12.x/api-reference/data-assets/topics/create) |
| `GET`    | `/v1/topics`                         | [List topics](/v1.12.x/api-reference/data-assets/topics/list)                     |
| `GET`    | `/v1/topics/{id}`                    | [Get by ID](/v1.12.x/api-reference/data-assets/topics/retrieve)                   |
| `GET`    | `/v1/topics/name/{fqn}`              | [Get by FQN](/v1.12.x/api-reference/data-assets/topics/retrieve)                  |
| `PATCH`  | `/v1/topics/{id}`                    | [Update by ID](/v1.12.x/api-reference/data-assets/topics/update)                  |
| `PATCH`  | `/v1/topics/name/{fqn}`              | [Update by name](/v1.12.x/api-reference/data-assets/topics/update)                |
| `DELETE` | `/v1/topics/{id}`                    | [Delete by ID](/v1.12.x/api-reference/data-assets/topics/delete)                  |
| `DELETE` | `/v1/topics/name/{fqn}`              | [Delete by name](/v1.12.x/api-reference/data-assets/topics/delete)                |
| `PUT`    | `/v1/topics/restore`                 | [Restore soft-deleted topic](/v1.12.x/api-reference/data-assets/topics/delete)    |
| `GET`    | `/v1/topics/{id}/versions`           | [List versions](/v1.12.x/api-reference/data-assets/topics/versions)               |
| `GET`    | `/v1/topics/{id}/versions/{version}` | [Get specific version](/v1.12.x/api-reference/data-assets/topics/versions)        |
| `PUT`    | `/v1/topics/{id}/followers`          | [Add follower](/v1.12.x/api-reference/data-assets/topics/followers-votes)         |
| `DELETE` | `/v1/topics/{id}/followers/{userId}` | [Remove follower](/v1.12.x/api-reference/data-assets/topics/followers-votes)      |
| `PUT`    | `/v1/topics/{id}/vote`               | [Add/update vote](/v1.12.x/api-reference/data-assets/topics/followers-votes)      |