List Messaging Services

List all messaging services with optional filtering and pagination

GET /v1/services/messagingServices

GET /v1/services/messagingServices

Python

import requests

base_url = "https://your-company.open-metadata.org/api"
headers = {"Authorization": "Bearer your-jwt-token"}

# List with pagination
response = requests.get(
    f"{base_url}/v1/services/messagingServices",
    params={"limit": 50, "fields": "owners,tags"},
    headers=headers
)
page = response.json()
for svc in page["data"]:
    print(f"{svc['name']} ({svc['serviceType']})")

# Filter by domain
response = requests.get(
    f"{base_url}/v1/services/messagingServices",
    params={"domain": "engineering", "limit": 50},
    headers=headers
)

Response

{
  "data": [
    {
      "id": "469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
      "name": "sample_kafka",
      "fullyQualifiedName": "sample_kafka",
      "serviceType": "Kafka",
      "connection": {
        "config": {
          "type": "Kafka",
          "bootstrapServers": "localhost:9092",
          "securityProtocol": "PLAINTEXT",
          "saslMechanism": "PLAIN",
          "schemaRegistryTopicSuffixName": "-value",
          "supportsMetadataExtraction": true
        }
      },
      "tags": [],
      "version": 0.1,
      "updatedAt": 1769982621031,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
      "deleted": false,
      "owners": [],
      "domains": []
    }
  ],
  "paging": {
    "after": "eyJ...",
    "total": 3
  }
}

List Messaging Services

List all messaging services with optional filtering and pagination.

Query Parameters

limit · integer · default: "10"

Maximum number of results to return (max: 1000000).

before · string

Cursor for backward pagination.

after · string

Cursor for forward pagination.

fields · string

Comma-separated list of fields to include. Valid fields: pipelines, owners, tags, domains, followers.

domain · string

Filter by domain fully qualified name.

include · string · default: "non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/services/messagingServices

Python

import requests

base_url = "https://your-company.open-metadata.org/api"
headers = {"Authorization": "Bearer your-jwt-token"}

# List with pagination
response = requests.get(
    f"{base_url}/v1/services/messagingServices",
    params={"limit": 50, "fields": "owners,tags"},
    headers=headers
)
page = response.json()
for svc in page["data"]:
    print(f"{svc['name']} ({svc['serviceType']})")

# Filter by domain
response = requests.get(
    f"{base_url}/v1/services/messagingServices",
    params={"domain": "engineering", "limit": 50},
    headers=headers
)

Response

{
  "data": [
    {
      "id": "469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
      "name": "sample_kafka",
      "fullyQualifiedName": "sample_kafka",
      "serviceType": "Kafka",
      "connection": {
        "config": {
          "type": "Kafka",
          "bootstrapServers": "localhost:9092",
          "securityProtocol": "PLAINTEXT",
          "saslMechanism": "PLAIN",
          "schemaRegistryTopicSuffixName": "-value",
          "supportsMetadataExtraction": true
        }
      },
      "tags": [],
      "version": 0.1,
      "updatedAt": 1769982621031,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
      "deleted": false,
      "owners": [],
      "domains": []
    }
  ],
  "paging": {
    "after": "eyJ...",
    "total": 3
  }
}

---

Returns

Returns a paginated list of messaging service objects. By default, only basic fields are included. Use the fields parameter to request additional data.

Response

data · array

Array of messaging service objects.

Show properties

id · string

Unique identifier for the messaging service (UUID format).

name · string

Messaging service name.

fullyQualifiedName · string

Fully qualified name of the service.

displayName · string

Human-readable display name.

serviceType · string

Type of messaging service (e.g., Kafka, Redpanda, Kinesis).

owners · array

List of owners assigned to the service. Only included when fields contains owners.

tags · array

Classification tags applied to the service. Only included when fields contains tags.

domains · array

Domain assignments for governance. Only included when fields contains domains.

pipelines · array

Ingestion pipelines associated with this service. Only included when fields contains pipelines.

followers · array

Users following this service. Only included when fields contains followers.

paging · object

Pagination information.

Show properties

total · integer

Total count of messaging services matching the query.

after · string

Cursor for the next page of results. Null if this is the last page.

before · string

Cursor for the previous page of results. Null if this is the first page.