Skip to main content
POST
Upsert

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
id
string

Opaque id of the domain. Accepts either the bare UUID or the domain-<uuid> form — the prefix is stripped server-side, so the value you read back from any API can be passed straight in. The same id updates the same domain; a new id creates a new domain.

Pattern: ^(domain-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
name
string | null

Name. Required when creating; omit to keep the existing name on update.

Required string length: 1 - 100
description
string | null

Description. Omit to keep the existing description.

Maximum string length: 10000
parentId
string | null

Parent domain, making this a sub-domain. Omit to keep the current parent; pass an empty string to detach the domain and make it top-level. Accepts the bare UUID or the domain-<uuid> form. The parent must already exist, and the write is rejected if it would make the hierarchy loop.

Pattern: ^$|^(domain-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
source
enum<string> | null

Source. Omit to keep the existing source (defaults to SOURCE_SYNQ on create).

Available options:
SOURCE_SYNQ,
SOURCE_ATLAN
definition
DomainDefinition · object | null

Membership definition. Omit to keep the existing definition; pass a present (possibly empty) definition to replace it.

etag
string | null

Optional optimistic-concurrency guard. When set, the update fails with a conflict if the domain was modified since this etag was read.

actor
Actor · object

Who is performing this write. Optional — identity is completed from the calling credentials; set it to attribute the change on behalf of a user.

Response

200 - application/json

Success

domain
Domain · object

The stored domain after the upsert.