Upsert
Create or update a domain. The id is supplied by the caller (a UUID);
repeating the same request converges to the same domain. Mutable fields are
optional: a set field is written, an omitted field is left unchanged. Pass
etag to guard against overwriting a concurrent edit.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
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.
^(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. Required when creating; omit to keep the existing name on update.
1 - 100Description. Omit to keep the existing description.
10000Parent 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.
^$|^(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. Omit to keep the existing source (defaults to SOURCE_SYNQ on create).
SOURCE_SYNQ, SOURCE_ATLAN Membership definition. Omit to keep the existing definition; pass a present (possibly empty) definition to replace it.
Optional optimistic-concurrency guard. When set, the update fails with a conflict if the domain was modified since this etag was read.
Who is performing this write. Optional — identity is completed from the calling credentials; set it to attribute the change on behalf of a user.
- Actor
- Actor
- Actor
Response
Success
The stored domain after the upsert.