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

# Messaging Services

> Create, retrieve, update, and delete messaging service connections with authentication and configuration for metadata ingestion across your data infrastructure using the Collate REST API.

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

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

## Entity Hierarchy

Messaging Services are at the top of the hierarchy:

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

***

## API Endpoints

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