Skip to main content
put/custom-domain
Request example
Response
put/custom-domain

Authorization

x-api-keystringheaderrequired#
The API key to authenticate requests.

2 alternative authorization methods available — see the spec for details.

Body

application/json
hostnamestringrequired#
A domain such as resume.example.com.

Length: max 260

Responses

application/json
OK
hostnamestringrequired#
The domain, as DNS knows it (lowercase ASCII).
targetstringrequired#
The host the domain's CNAME record points at.
txtNamestringrequired#
Where the TXT record that proves ownership goes.
txtValuestringrequired#
The TXT record's value.
recordsobject[]required#
Every record to add: the TXT record, and a CNAME to the target, or for a root domain A and AAAA records with its addresses.
verifiedbooleanrequired#
Whether DNS proved ownership and the domain opens the primary resume.
lastCheckedAtstring · nullrequired#
When DNS was last checked.