clave docs

Domains

A site is live on a Clave address as soon as it is published. A domain puts it on the owner's own address as well.

Onboard, then attach

  1. Onboard the domain with POST /v1/domains. Clave reports the modes it supports, so an agent picks one by lookup rather than by being refused.
  2. Attach it to a site with POST /v1/domains/{id}/attach.

The certificate and the DNS are automatic on attach.

A site has one domain. To change it, detach the old domain first. A second attach answers 409 site_has_domain.

Clave does not register domains

POST /v1/domains onboards a domain the owner already registered. There is no registrar here. An owner who has no domain buys one first.

When a domain is ready

A domain is ready only when its status and its ssl.status are both active. The status goes active before the certificate does, so a report on the status alone would tell an owner the domain is live while the certificate is still being issued.

States that look like failures

Moved and Deleted are recoverable. Clave retries them on a schedule.

Blocked needs a person. It means the domain was flagged for abuse.

Records

GET /v1/domains/{id}/records reads the DNS records of an onboarded domain, and POST and DELETE write and remove them. This is for the records the site needs, such as mail.

Mail from the domain

A site's code can send mail to visitors from an address on its domain, such as hello@example.com. This is the only way a site sends mail to visitors: without it, runtime mail is refused. The owner is responsible for what the site sends. Mail that bounces or is marked as spam too often stops the site's mail.

Read Domains.