Add a domain

Registers a hostname. It stays unverified until its DNS record resolves.
POSThttps://api.clicklookup.com/v1/domains

Requires an API key

Request body2

  • hostnamestringrequired

    Lower-case hostname, e.g. go.example.com

    4–253 chars
  • recordTypeenum
    One ofcnameaDefault "cname"

Response · 20113

  • cloakbooleanrequired

    Serve cloak meta tags on this domain

  • createdAtstring · date-timerequired

    ISO-8601 timestamp with offset

  • hostnamestringrequired

    Lower-case hostname, e.g. go.example.com

    4–253 chars
  • idstring · uuidrequired

    UUID primary key

  • isDefaultbooleanrequired

    New links in this workspace use it unless told otherwise

  • kindenumrequired

    Ours to run, or the customer's own domain

    One ofmanagedcustom
  • lastCheckedAtstring · date-timerequired
  • lastErrorstringrequired
    max 300 chars
  • recordTypeenumrequired

    The DNS record the customer points at the edge

    One ofcnamea
  • statusenumrequired

    Lifecycle state.

    One ofpendingverifiedfailed
  • verificationTokenstringrequired

    Expected in the _clicklookup TXT record

    32–32 chars
  • verifiedAtstring · date-timerequired
  • workspaceIdstring · uuidrequired

    UUID primary key