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.

Entity schema follows the OpenMetadata Standard.

Entity Hierarchy

Messaging Services are at the top of the hierarchy:

MessagingService (this page)
└── Topic

API Endpoints

Method	Endpoint	Description
`PUT`	`/v1/services/messagingServices`	Create or update
`POST`	`/v1/services/messagingServices`	Create (POST variant)
`GET`	`/v1/services/messagingServices`	List services
`GET`	`/v1/services/messagingServices/{id}`	Get by ID
`GET`	`/v1/services/messagingServices/name/{fqn}`	Get by name
`PATCH`	`/v1/services/messagingServices/{id}`	Update by ID
`PATCH`	`/v1/services/messagingServices/name/{fqn}`	Update by name
`DELETE`	`/v1/services/messagingServices/{id}`	Delete by ID
`DELETE`	`/v1/services/messagingServices/name/{fqn}`	Delete by name
`PUT`	`/v1/services/messagingServices/restore`	Restore
`GET`	`/v1/services/messagingServices/{id}/versions`	List versions
`GET`	`/v1/services/messagingServices/{id}/versions/{version}`	Get version
`GET`	`/v1/services/messagingServices/name/{fqn}/export`	Export CSV
`PUT`	`/v1/services/messagingServices/name/{fqn}/import`	Import CSV
`GET`	`/v1/services/messagingServices/name/{fqn}/exportAsync`	Export CSV async
`PUT`	`/v1/services/messagingServices/name/{fqn}/importAsync`	Import CSV async
`POST`	`/v1/services/messagingServices/{id}/testConnectionResult`	Add test connection result

Database Versions

Create a Messaging Service

​Messaging Services

​Entity Hierarchy

​API Endpoints

Messaging Services

Entity Hierarchy

API Endpoints