PUT /v1/domains

curl -X PUT "{base_url}/api/v1/domains" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "TestDomain",
    "domainType": "Aggregate",
    "description": "Lorem ipsum...",
    "owners": [],
    "experts": []
  }'

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.root}")

// client is an initialized OpenMetadataClient.
var domainId = "a0729e98-e946-4e25-acde-10e8a2294ba1";
var domain = client.domains().get(domainId);
domain.setDescription("Updated domain description for business analytics");

var updated = client.domains().update(domainId, domain);

# Update by ID
curl -X PATCH "{base_url}/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated domain description for business analytics"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/domains/name/TestDomain" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated domain description for business analytics"}
  ]'

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

PUT

domains

PUT /v1/domains

curl -X PUT "{base_url}/api/v1/domains" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "TestDomain",
    "domainType": "Aggregate",
    "description": "Lorem ipsum...",
    "owners": [],
    "experts": []
  }'

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.root}")

// client is an initialized OpenMetadataClient.
var domainId = "a0729e98-e946-4e25-acde-10e8a2294ba1";
var domain = client.domains().get(domainId);
domain.setDescription("Updated domain description for business analytics");

var updated = client.domains().update(domainId, domain);

# Update by ID
curl -X PATCH "{base_url}/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated domain description for business analytics"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/domains/name/TestDomain" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated domain description for business analytics"}
  ]'

{
  "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

Create a domain or update it if it already exists, using PUT /v1/domains with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

Body Parameters

string

required

Name of the domain. Must be unique at the same level (top-level or within a parent domain).

string

required

Type of domain. One of: Source-aligned, Consumer-aligned, Aggregate.

string

Human-readable display name for the domain.

string

required

Description of the domain in Markdown format.

string

Fully qualified name of the parent domain for creating nested domains, for example Engineering.

array

Array of owner references (users or teams) to assign to the domain.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Array of user names, as strings, of the subject matter experts for this domain.

PUT /v1/domains

curl -X PUT "{base_url}/api/v1/domains" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "TestDomain",
    "domainType": "Aggregate",
    "description": "Lorem ipsum...",
    "owners": [],
    "experts": []
  }'

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.root}")

// client is an initialized OpenMetadataClient.
var domainId = "a0729e98-e946-4e25-acde-10e8a2294ba1";
var domain = client.domains().get(domainId);
domain.setDescription("Updated domain description for business analytics");

var updated = client.domains().update(domainId, domain);

# Update by ID
curl -X PATCH "{base_url}/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated domain description for business analytics"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/domains/name/TestDomain" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated domain description for business analytics"}
  ]'

{
  "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

string

Unique identifier for the domain (UUID format).

string

Domain name.

string

Fully qualified name of the domain.

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid or malformed request body
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this domain
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

Collaboration

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Update a Domain

Update a Domain

Body Parameters

Returns

Response

Error Handling