Update a Domain

Update domain properties using JSON Patch

PATCH /v1/domains/{id}

PATCH /v1/domains/{id}

Python

from metadata.sdk import configure
from metadata.sdk.entities import Domains

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

# Retrieve, modify, and update
domain = Domains.retrieve("a0729e98-e946-4e25-acde-10e8a2294ba1")
domain.description = "Updated domain description for business analytics"
domain.domainType = "Consumer-aligned"
updated = Domains.update(domain)

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

Response

{
  "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
  "domainType": "Consumer-aligned",
  "name": "TestDomain",
  "fullyQualifiedName": "TestDomain",
  "description": "Updated domain description for business analytics",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1",
  "deleted": false,
  "owners": [],
  "children": []
}

Update a Domain

Update a domain’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 domain to update.

Update by Name

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

fqn · string · required

Fully qualified name of the domain (e.g., TestDomain).

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.

domainType · string

Updated domain type: Source-aligned, Consumer-aligned, or Aggregate.

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).

experts · array

Updated list of expert references.

Show properties

id · string

UUID of the user.

type · string

Type of entity (always user).

PATCH /v1/domains/{id}

Python

from metadata.sdk import configure
from metadata.sdk.entities import Domains

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

# Retrieve, modify, and update
domain = Domains.retrieve("a0729e98-e946-4e25-acde-10e8a2294ba1")
domain.description = "Updated domain description for business analytics"
domain.domainType = "Consumer-aligned"
updated = Domains.update(domain)

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

Response

{
  "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
  "domainType": "Consumer-aligned",
  "name": "TestDomain",
  "fullyQualifiedName": "TestDomain",
  "description": "Updated domain description for business analytics",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1",
  "deleted": false,
  "owners": [],
  "children": []
}

---

Returns

Returns the updated domain object with the new version number.

Response

id · string

Unique identifier for the domain (UUID format).

name · string

Domain name.

fullyQualifiedName · string

Fully qualified name of the domain.

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 domain
404	NOT_FOUND	Domain with given ID or FQN does not exist
409	CONFLICT	Concurrent modification detected