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

# Messaging Services

> Create and manage messaging service connections

# Messaging Services

A **Messaging Service** represents a connection to a messaging platform (e.g., Kafka, Redpanda, Kinesis). It is the root of the messaging hierarchy and contains Topics.

> [!NOTE]
>
> Entity schema follows the [OpenMetadata Standard](https://openmetadatastandards.org/data-assets/messaging/messaging-service/).

## Entity Hierarchy

Messaging Services are at the top of the hierarchy:

```txt Messaging Service theme={null}
MessagingService (this page)
└── Topic
```

***

## API Endpoints

| Method | Endpoint | Description |
| - | - | - |
| `PUT` | `/v1/services/messagingServices` | [Create or update](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/create.md) |
| `POST` | `/v1/services/messagingServices` | [Create (POST variant)](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/create.md) |
| `GET` | `/v1/services/messagingServices` | [List services](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/list.md) |
| `GET` | `/v1/services/messagingServices/{id}` | [Get by ID](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/retrieve.md) |
| `GET` | `/v1/services/messagingServices/name/{fqn}` | [Get by name](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/retrieve.md) |
| `PATCH` | `/v1/services/messagingServices/{id}` | [Update by ID](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/update.md) |
| `PATCH` | `/v1/services/messagingServices/name/{fqn}` | [Update by name](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/update.md) |
| `DELETE` | `/v1/services/messagingServices/{id}` | [Delete by ID](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/delete.md) |
| `DELETE` | `/v1/services/messagingServices/name/{fqn}` | [Delete by name](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/delete.md) |
| `PUT` | `/v1/services/messagingServices/restore` | [Restore](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/delete.md) |
| `GET` | `/v1/services/messagingServices/{id}/versions` | [List versions](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/versions.md) |
| `GET` | `/v1/services/messagingServices/{id}/versions/{version}` | [Get version](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/versions.md) |
| `GET` | `/v1/services/messagingServices/name/{fqn}/export` | [Export CSV](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/import-export.md) |
| `PUT` | `/v1/services/messagingServices/name/{fqn}/import` | [Import CSV](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/import-export.md) |
| `GET` | `/v1/services/messagingServices/name/{fqn}/exportAsync` | [Export CSV async](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/import-export.md) |
| `PUT` | `/v1/services/messagingServices/name/{fqn}/importAsync` | [Import CSV async](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/import-export.md) |
| `POST` | `/v1/services/messagingServices/{id}/testConnectionResult` | [Add test connection result](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/api-reference/data-assets/messaging-services/create.md) |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.