Skip to main content

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

MethodEndpointDescription
PUT/v1/services/messagingServicesCreate or update
POST/v1/services/messagingServicesCreate (POST variant)
GET/v1/services/messagingServicesList 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/restoreRestore
GET/v1/services/messagingServices/{id}/versionsList versions
GET/v1/services/messagingServices/{id}/versions/{version}Get version
GET/v1/services/messagingServices/name/{fqn}/exportExport CSV
PUT/v1/services/messagingServices/name/{fqn}/importImport CSV
GET/v1/services/messagingServices/name/{fqn}/exportAsyncExport CSV async
PUT/v1/services/messagingServices/name/{fqn}/importAsyncImport CSV async
POST/v1/services/messagingServices/{id}/testConnectionResultAdd test connection result