Sign in
Content Management

Verify Guide Domain

Check the ownership TXT record and, on success, activate the domain.

This is the gate. Everything before it is a claim; provisioning a certificate for a hostname nobody has proved they control would let one tenant take an address that already resolves to us.

post/api/v1/content/domains/{domain_id}/verify

Path parameters

domain_idstring uuid required

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

Changed in 1 of the 5 revisions of this API.2

  • d65b8fefae342See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog