Skip to main content
PATCH
PATCH /v1/domains/{id}

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

string
required
UUID of the domain to update.

Update by Name

Use PATCH /v1/domains/name/{fqn} to update by fully qualified name.
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.
string
Updated description in Markdown format.
string
Updated display name.
string
Updated domain type: Source-aligned, Consumer-aligned, or Aggregate.
array
Updated list of owner references.
array
Updated list of expert references.
PATCH /v1/domains/{id}

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