Update a Topic

Update topic properties using JSON Patch

PATCH /v1/topics/{id}

PATCH /v1/topics/{id}

Python

from metadata.sdk import configure
from metadata.sdk.entities import Topics

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
topic = Topics.retrieve("0a021819-982e-4ee4-a5a2-4af30eaa3016")
topic.description = "Updated: All Protobuf record events captured with enhanced schema"
topic.messageSchema = {
    "schemaType": "Protobuf",
    "schemaText": "syntax = \"proto3\";\npackage tutorial;\nmessage Person { ... }"
}
updated = Topics.update(topic)

print(f"Updated to version {updated.version}")

Response

{
  "id": "0a021819-982e-4ee4-a5a2-4af30eaa3016",
  "name": "address_book",
  "fullyQualifiedName": "sample_kafka.address_book",
  "description": "Updated: All Protobuf record events captured with enhanced schema",
  "version": 0.2,
  "updatedAt": 1769982663546,
  "updatedBy": "admin",
  "service": {
    "id": "469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    "type": "messagingService",
    "name": "sample_kafka",
    "fullyQualifiedName": "sample_kafka",
    "displayName": "sample_kafka",
    "deleted": false
  },
  "serviceType": "Kafka",
  "messageSchema": {
    "schemaText": "syntax = \"proto2\";\npackage tutorial;\nmessage Person { ... }",
    "schemaType": "Protobuf",
    "schemaFields": [
      {
        "name": "AddressBook",
        "dataType": "RECORD",
        "fullyQualifiedName": "sample_kafka.address_book.AddressBook",
        "children": []
      }
    ]
  },
  "partitions": 1,
  "cleanupPolicies": ["delete"],
  "replicationFactor": 1,
  "maximumMessageSize": 1,
  "retentionSize": -1,
  "href": "http://localhost:8585/api/v1/topics/0a021819-982e-4ee4-a5a2-4af30eaa3016",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

Update a Topic

Update a topic’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

Update by ID

id · string · required

UUID of the topic to update.

Update by Name

Use PATCH /v1/topics/name/{fqn} to update by fully qualified name.

fqn · string · required

Fully qualified name of the topic (e.g., sample_kafka.address_book).

Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.

description · string

Updated description in Markdown format.

displayName · string

Updated display name.

messageSchema · object

Updated message schema.

Show properties

schemaType · string

Type of schema (e.g., Avro, Protobuf, JSON, Other).

schemaText · string

The schema definition text.

owners · array

Updated list of owner references.

Show properties

id · string

UUID of the owner entity.

type · string

Type of owner entity (e.g., user, team).

tags · array

Updated classification tags.

Show properties

tagFQN · string · required

Fully qualified name of the tag.

labelType · string

Type of label (e.g., Manual, Derived, Propagated).

state · string

State of the tag (e.g., Suggested, Confirmed).

domain · string

Updated domain FQN.

extension · object

Updated custom property values.

PATCH /v1/topics/{id}

Python

from metadata.sdk import configure
from metadata.sdk.entities import Topics

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
topic = Topics.retrieve("0a021819-982e-4ee4-a5a2-4af30eaa3016")
topic.description = "Updated: All Protobuf record events captured with enhanced schema"
topic.messageSchema = {
    "schemaType": "Protobuf",
    "schemaText": "syntax = \"proto3\";\npackage tutorial;\nmessage Person { ... }"
}
updated = Topics.update(topic)

print(f"Updated to version {updated.version}")

Response

{
  "id": "0a021819-982e-4ee4-a5a2-4af30eaa3016",
  "name": "address_book",
  "fullyQualifiedName": "sample_kafka.address_book",
  "description": "Updated: All Protobuf record events captured with enhanced schema",
  "version": 0.2,
  "updatedAt": 1769982663546,
  "updatedBy": "admin",
  "service": {
    "id": "469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    "type": "messagingService",
    "name": "sample_kafka",
    "fullyQualifiedName": "sample_kafka",
    "displayName": "sample_kafka",
    "deleted": false
  },
  "serviceType": "Kafka",
  "messageSchema": {
    "schemaText": "syntax = \"proto2\";\npackage tutorial;\nmessage Person { ... }",
    "schemaType": "Protobuf",
    "schemaFields": [
      {
        "name": "AddressBook",
        "dataType": "RECORD",
        "fullyQualifiedName": "sample_kafka.address_book.AddressBook",
        "children": []
      }
    ]
  },
  "partitions": 1,
  "cleanupPolicies": ["delete"],
  "replicationFactor": 1,
  "maximumMessageSize": 1,
  "retentionSize": -1,
  "href": "http://localhost:8585/api/v1/topics/0a021819-982e-4ee4-a5a2-4af30eaa3016",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

---

Returns

Returns the updated topic object with the new version number.

Response

id · string

Unique identifier for the topic (UUID format).

name · string

Topic name.

fullyQualifiedName · string

Fully qualified name in format service.topicName.

description · string

Updated description.

version · number

Incremented version number.

---

Error Handling

Code	Error Type	Description
400	BAD_REQUEST	Invalid JSON patch or malformed request
401	UNAUTHORIZED	Invalid or missing authentication token
403	FORBIDDEN	User lacks permission to update this topic
404	NOT_FOUND	Topic with given ID or FQN does not exist
409	CONFLICT	Concurrent modification detected