Sign in
Content Management

Create Guide Domain

Claim a domain and assign what it serves — atomically.

One transaction. The previous flow created a group with no host, then updated it, then set membership: three mutations where the second or third could fail after the first succeeded, leaving a hostless group that no domain-keyed surface can render.

post/api/v1/content/domains

Request body

addressstring required
property_idsstring[] required
group_namestring nullable

Response

Successful Response

idstring uuid required
hostnamestring required
kind'CNAME_SINGLE' | 'CNAME_GROUP' | 'WORKER' required

How a hostname reaches us, and therefore what it can serve.

Named for the SHAPE of the address, not the vendor mechanism — the operator never sees "CNAME" or "Worker", and the two questions that determine this (own host or folder? one guide or several?) are the ones the UI asks.

path_prefixstring nullable required
addressstring required
state'needs_verification' | 'needs_dns' | 'pointing_elsewhere' | 'securing' | 'ready' | 'live' | 'action_needed' | 'check_unavailable' required
messagestring required
actionstring nullable
expected_recordstring nullable
observed_targetstring nullable
tls_statusstring nullable
ownership_recordstring nullable
ownership_tokenstring nullable
verifiedboolean

Changes

No recorded changes to this endpoint across all 1 revision of this API.