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

# Create a Messaging Service

> Create a new messaging service connection

# Create a Messaging Service

Create a new messaging service connection to a platform such as Kafka, Redpanda, or Kinesis.

## Body Parameters

<ParamField body="name" type="string" required>
  Name of the messaging service. Must be unique across all messaging services.
</ParamField>

<ParamField body="serviceType" type="string" required>
  Type of messaging service (e.g., `Kafka`, `Redpanda`, `Kinesis`, `CustomMessaging`).
</ParamField>

<ParamField body="description" type="string">
  Description of the messaging service in Markdown format.
</ParamField>

<ParamField body="displayName" type="string">
  Human-readable display name for the messaging service.
</ParamField>

<ParamField body="connection" type="object" required>
  Connection configuration specific to the service type.

  <Expandable title="properties">
    <ParamField body="config" type="object">
      Service-specific connection configuration (e.g., bootstrapServers, securityProtocol for Kafka).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="owners" type="array">
  Array of owner references (users or teams) to assign to the service.

  <Expandable title="properties">
    <ParamField body="id" type="string">
      UUID of the owner entity.
    </ParamField>

    <ParamField body="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ParamField>

    <ParamField body="name" type="string">
      Name of the owner entity.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="domain" type="string">
  Fully qualified name of the domain to assign for governance purposes.
</ParamField>

<ParamField body="tags" type="array">
  Array of classification tags to apply to the messaging service.

  <Expandable title="properties">
    <ParamField body="tagFQN" type="string" required>
      Fully qualified name of the tag.
    </ParamField>

    <ParamField body="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ParamField>

    <ParamField body="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ParamField>
  </Expandable>
</ParamField>

<RequestExample dropdown>
  ```python POST /v1/services/messagingServices theme={null}
  import requests

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

  payload = {
      "name": "sample_kafka",
      "displayName": "Sample Kafka",
      "serviceType": "Kafka",
      "description": "Production Kafka messaging service",
      "connection": {
          "config": {
              "type": "Kafka",
              "bootstrapServers": "localhost:9092",
              "securityProtocol": "PLAINTEXT",
              "saslMechanism": "PLAIN",
              "schemaRegistryTopicSuffixName": "-value",
              "supportsMetadataExtraction": True
          }
      }
  }

  response = requests.post(
      f"{base_url}/v1/services/messagingServices",
      json=payload,
      headers=headers
  )
  service = response.json()
  print(f"Created: {service['fullyQualifiedName']}")
  ```

  ```java POST /v1/services/messagingServices theme={null}
  import static org.openmetadata.sdk.fluent.MessagingServices.*;

  MessagingService service = MessagingServices.builder()
      .name("sample_kafka")
      .serviceType("Kafka")
      .connection(kafkaConnection()
          .bootstrapServers("localhost:9092")
          .securityProtocol("PLAINTEXT")
          .saslMechanism("PLAIN"))
      .create();
  ```

  ```bash POST /v1/services/messagingServices theme={null}
  curl -X POST "{base_url}/api/v1/services/messagingServices" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "sample_kafka",
      "serviceType": "Kafka",
      "description": "Production Kafka messaging service",
      "connection": {
        "config": {
          "type": "Kafka",
          "bootstrapServers": "localhost:9092",
          "securityProtocol": "PLAINTEXT",
          "saslMechanism": "PLAIN",
          "schemaRegistryTopicSuffixName": "-value",
          "supportsMetadataExtraction": true
        }
      }
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "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": []
  }
  ```
</ResponseExample>

***

## Returns

Returns the created messaging service object with all specified properties and system-generated fields.

## Response

<ResponseField name="id" type="string">
  Unique identifier for the messaging service (UUID format).
</ResponseField>

<ResponseField name="name" type="string">
  Messaging service name.
</ResponseField>

<ResponseField name="fullyQualifiedName" type="string">
  Fully qualified name of the service.
</ResponseField>

<ResponseField name="displayName" type="string">
  Human-readable display name.
</ResponseField>

<ResponseField name="description" type="string">
  Description of the messaging service in Markdown format.
</ResponseField>

<ResponseField name="serviceType" type="string">
  Type of messaging service (e.g., Kafka, Redpanda, Kinesis).
</ResponseField>

<ResponseField name="connection" type="object">
  Connection configuration for the service.

  <Expandable title="properties">
    <ResponseField name="config" type="object">
      Service-specific connection configuration.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="owners" type="array" optional>
  List of owners assigned to the messaging service.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      UUID of the owner entity.
    </ResponseField>

    <ResponseField name="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the owner entity.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="domain" type="string" optional>
  Fully qualified name of the assigned domain.
</ResponseField>

<ResponseField name="tags" type="array" optional>
  Classification tags applied to the messaging service.

  <Expandable title="properties">
    <ResponseField name="tagFQN" type="string">
      Fully qualified name of the tag.
    </ResponseField>

    <ResponseField name="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ResponseField>

    <ResponseField name="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="version" type="number">
  Version number for the entity (starts at 0.1).
</ResponseField>

***

## Create or Update (PUT)

Use `PUT /v1/services/messagingServices` instead of `POST` to perform an upsert. If a messaging service with the same `fullyQualifiedName` already exists, it will be updated; otherwise, a new service is created. The request body is the same as `POST`.

```bash theme={null}
curl -X PUT "{base_url}/api/v1/services/messagingServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'
```

<Note>
  `PUT` will not return a `409` conflict error if the entity already exists -- it will update the existing entity instead.
</Note>

***

## Bulk Create or Update (PUT)

Use `PUT /v1/services/messagingServices/bulk` to create or update multiple messaging services in a single request. The request body is an array of create request objects.

```bash theme={null}
curl -X PUT "{base_url}/api/v1/services/messagingServices/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "kafka_prod", "serviceType": "Kafka", "connection": { "config": {} } },
    { "name": "redpanda_staging", "serviceType": "Redpanda", "connection": { "config": {} } }
  ]'
```

***

## Error Handling

| Code  | Error Type              | Description                                                 |
| ----- | ----------------------- | ----------------------------------------------------------- |
| `400` | `BAD_REQUEST`           | Invalid request body or missing required fields             |
| `401` | `UNAUTHORIZED`          | Invalid or missing authentication token                     |
| `403` | `FORBIDDEN`             | User lacks permission to create messaging services          |
| `409` | `ENTITY_ALREADY_EXISTS` | Messaging service with same name already exists (POST only) |