GET /v1/services/messagingServices/{id}

import requests

base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}

# Get by ID
response = requests.get(
    f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    headers=headers
)
service = response.json()
print(f"{service['fullyQualifiedName']}: {service['serviceType']}")

# Get by ID with fields
response = requests.get(
    f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    params={"fields": "owners,tags"},
    headers=headers
)

# Get by fully qualified name
response = requests.get(
    f"{base_url}/v1/services/messagingServices/name/sample_kafka",
    headers=headers
)

# Get by name with fields
response = requests.get(
    f"{base_url}/v1/services/messagingServices/name/sample_kafka",
    params={"fields": "owners,tags,domains"},
    headers=headers
)

import static org.openmetadata.sdk.fluent.MessagingServices.*;

// Get by ID
MessagingService service = MessagingServices.retrieve("469ef25e-9bdf-4d5f-8553-eb0ce8581f30");

// Get by fully qualified name
MessagingService service = MessagingServices.retrieveByName("sample_kafka");

# Get by ID
curl "{base_url}/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30?fields=owners,tags" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/services/messagingServices/name/sample_kafka" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/services/messagingServices/name/sample_kafka?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

GET

services

messagingServices

{id}

GET /v1/services/messagingServices/{id}

import requests

base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}

# Get by ID
response = requests.get(
    f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    headers=headers
)
service = response.json()
print(f"{service['fullyQualifiedName']}: {service['serviceType']}")

# Get by ID with fields
response = requests.get(
    f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    params={"fields": "owners,tags"},
    headers=headers
)

# Get by fully qualified name
response = requests.get(
    f"{base_url}/v1/services/messagingServices/name/sample_kafka",
    headers=headers
)

# Get by name with fields
response = requests.get(
    f"{base_url}/v1/services/messagingServices/name/sample_kafka",
    params={"fields": "owners,tags,domains"},
    headers=headers
)

import static org.openmetadata.sdk.fluent.MessagingServices.*;

// Get by ID
MessagingService service = MessagingServices.retrieve("469ef25e-9bdf-4d5f-8553-eb0ce8581f30");

// Get by fully qualified name
MessagingService service = MessagingServices.retrieveByName("sample_kafka");

# Get by ID
curl "{base_url}/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30?fields=owners,tags" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/services/messagingServices/name/sample_kafka" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/services/messagingServices/name/sample_kafka?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

Retrieve a Messaging Service

Get a single messaging service by its unique ID or fully qualified name.

Get by ID

string

required

UUID of the messaging service to retrieve.

string

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

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/services/messagingServices/name/{fqn} to retrieve by fully qualified name.

string

required

Fully qualified name of the messaging service (e.g., sample_kafka).

string

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

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/services/messagingServices/{id}

import requests

base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}

# Get by ID
response = requests.get(
    f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    headers=headers
)
service = response.json()
print(f"{service['fullyQualifiedName']}: {service['serviceType']}")

# Get by ID with fields
response = requests.get(
    f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    params={"fields": "owners,tags"},
    headers=headers
)

# Get by fully qualified name
response = requests.get(
    f"{base_url}/v1/services/messagingServices/name/sample_kafka",
    headers=headers
)

# Get by name with fields
response = requests.get(
    f"{base_url}/v1/services/messagingServices/name/sample_kafka",
    params={"fields": "owners,tags,domains"},
    headers=headers
)

import static org.openmetadata.sdk.fluent.MessagingServices.*;

// Get by ID
MessagingService service = MessagingServices.retrieve("469ef25e-9bdf-4d5f-8553-eb0ce8581f30");

// Get by fully qualified name
MessagingService service = MessagingServices.retrieveByName("sample_kafka");

# Get by ID
curl "{base_url}/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30?fields=owners,tags" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/services/messagingServices/name/sample_kafka" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/services/messagingServices/name/sample_kafka?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

Returns

Returns a messaging service object with all requested fields populated.

Response

string

Unique identifier for the messaging service (UUID format).

string

Messaging service name.

string

Fully qualified name of the service.

string

Human-readable display name.

string

Description of the messaging service in Markdown format.

string

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

object

Connection configuration for the service.

Show properties

object

Service-specific connection configuration.

number

Version number for the entity.

array

List of owners. Only included when fields contains owners.

array

Classification tags. Only included when fields contains tags.

array

Domain assignments. Only included when fields contains domains.

array

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

array

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

Error Handling

Code	Error Type	Description
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to view this messaging service
`404`	`NOT_FOUND`	Messaging service with given ID or FQN does not exist

Create a Messaging Service

Update a Messaging Service

⌘I

​Retrieve a Messaging Service

​Get by ID

​Get by Fully Qualified Name

​Returns

​Response

​Error Handling

Retrieve a Messaging Service

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling