List custom domains
cooper_list_domainsUse this when you need the custom domains on the signed-in account, including DNS status. Read-only; requires auth; no inputs. Returns {object:"list", data:[{id, domain, status, status_detail, mail, records, warnings, dns}]}. Each record has status valid, missing, or invalid, found from the last check, and hint (null, or {code, message, found_at} saying what to change). warnings is an empty array when none. existing_mail_provider means this hostname already has MX at another provider. Inboxes on your own domain are included on Starter (15 custom domains) and Pro (200 custom domains). Free includes 0 custom domains and returns HTTP 402 plan_limit_exceeded. When the hostname is already a zone on the operator Cloudflare account, Cooper writes the DNS records and dns.mode is automatic. Cooper does not register a domain or create a zone. Any other zone stays manual. Publish the routing MX hosts, TXT SPF v=spf1 include:_spf.mx.cloudflare.net ~all, the routing DKIM TXT, the cf-bounce MX, SPF, and DKIM records, a DMARC TXT (an existing DMARC record is left as it is), and the _cooper-verify TXT. mail.receiving stays false until the receiving records check out and the catch-all is live. Receiving goes live within a few minutes. status_detail says so while you wait. POST /api/v1/inboxes with domain then creates username@domain. DELETE /api/v1/domains/:id puts back the catch-all that was there before, deletes only the DNS records Cooper created, turns Email Routing off only if Cooper turned it on, and removes the sending domain only if Cooper created it. A cleanup that does not finish keeps the row with status cleanup_failed and deleted false so a later delete can finish it. Failure codes: unauthorized.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||