# Domains

Read [Domains](/concepts/domains) for what onboarding is and when a domain
is ready.

## Onboard

| Call | What it does |
|---|---|
| `POST /v1/domains` | onboards a domain the owner already registered |
| `GET /v1/domains` | every domain on the account |
| `GET /v1/domains/{id}` | one domain, with its status |
| `DELETE /v1/domains/{id}` | removes it from the account |

`GET /v1/account` reports `domain_onboarding` with the modes this
deployment supports. Read the modes rather than discover one by being
refused.

Clave does not register domains. There is no registrar here.

## Attach and detach

| Call | What it does |
|---|---|
| `POST /v1/domains/{id}/attach` | serves a site on the domain |
| `POST /v1/domains/{id}/detach` | stops serving it there |

Certificates and DNS are automatic on attach.

A domain is live only when its `status` **and** its `ssl.status` are both
active. The status goes active first, so do not tell an owner the domain
is live on that alone.

## Records

| Call | What it does |
|---|---|
| `GET /v1/domains/{id}/records` | the DNS records of the domain |
| `POST /v1/domains/{id}/records` | adds one |
| `DELETE /v1/domains/{id}/records/{record_id}` | removes one |

These are for what the owner needs beside the site, such as mail.

## Plans

A plan that includes a domain cannot be fulfilled end to end today,
because nothing here registers one. Clave reports which plans are sellable
rather than let a surface decide for itself.

---

## Where this page sits

This is one page of the Clave documentation.
Read it as a web page at https://docs.heyclave.party/api/domains.
Every page has a `.md` address, and https://docs.heyclave.party/llms.txt lists them all.

- Previous: [Comments](https://docs.heyclave.party/api/comments.md)
- Next: [Forms](https://docs.heyclave.party/api/forms.md)
- Index: [Overview](https://docs.heyclave.party/index.md)