Setting the file. One moment.
Subchapter 4.8
references/domains.mdMarkdown5 KBView on GitHub
Detailed flag specifications for resend domains commands.
List all domains.
| Flag | Type | Default | Description |
|---|
--limit <n> | number | 10 | Max results (1-100) |
--after <cursor> | string | — | Forward pagination |
--before <cursor> | string | — | Backward pagination |
Note: List does NOT include DNS records. Use domains get for full details.
Create a new domain and receive DNS records to configure.
| Flag | Type | Required | Description |
|---|---|---|---|
--name <domain> | string | Yes (non-interactive) | Domain name (e.g., example.com) |
--region <region> | string | No | us-east-1 | eu-west-1 | sa-east-1 | ap-northeast-1 |
--tls <mode> | string | No | opportunistic (default) | enforced |
--tracking-subdomain <subdomain> | string | No | Subdomain for click and open tracking (e.g., track) |
--custom-return-path <subdomain> | string | No | Subdomain for the Return-Path address (e.g., bounce) |
--sending | boolean | No | Enable sending (default: enabled) |
--receiving | boolean | No | Enable receiving (default: disabled) |
Output: Domain object with records[] array of DNS records to configure.
Argument: <id> — Domain ID
Returns full domain with records[], status (not_started|pending|verified|failed|temporary_failure), capabilities, region, open_tracking, click_tracking, tracking_subdomain. Records may include a Tracking CNAME record when a tracking subdomain is configured, and a TrackingCAA CAA record when the root domain has CAA records that require an additional entry for AWS certificate issuance.
Trigger async DNS verification.
Argument: <id> — Domain ID
Output: {"object":"domain","id":"..."}
Argument: <id> — Domain ID
| Flag | Type | Description |
|---|---|---|
--tls <mode> | string | opportunistic | enforced |
--open-tracking | boolean | Enable open tracking |
--no-open-tracking | boolean | Disable open tracking |
--click-tracking | boolean | Enable click tracking |
--no-click-tracking | boolean | Disable click tracking |
--tracking-subdomain <subdomain> | string | Subdomain for click and open tracking (e.g., track) |
At least one option required.
Argument: <id> — Domain ID
| Flag | Type | Required | Description |
|---|---|---|---|
--yes | boolean | Yes (non-interactive) | Skip confirmation |
Alias: rm
Claim a domain that another Resend account has already verified. The domain transfers to your account as a brand-new domain with fresh DKIM keys, so the previous account’s DNS records can’t be reused.
Lifecycle:
resend domains claim create --name example.com — returns the TXT record to addresend domains claim verify <domain-id> — trigger verification + transferresend domains claim get <domain-id> — poll until completedresend domains get <domain-id> for the records, update DNS, then resend domains verify <domain-id>Claim status values: pending | verified | completed | blocked | expired | superseded | canceled | failed.
| Flag | Type | Required | Description |
|---|---|---|---|
--name <domain> | string | Yes (non-interactive) | Domain name to claim (e.g., example.com) |
--region <region> | string | No | us-east-1 | eu-west-1 | sa-east-1 | ap-northeast-1 |
--tracking-subdomain <subdomain> | string | No | Subdomain for click and open tracking (e.g., track) |
--custom-return-path <subdomain> | string | No | Subdomain for the Return-Path address (e.g., bounce) |
--open-tracking / --no-open-tracking | boolean | No | Enable/disable open tracking |
--click-tracking / --no-click-tracking | boolean | No | Enable/disable click tracking |
Output: domain_claim object with domain_id (the placeholder domain) and a TXT record to add to DNS.
Argument: <id> — Domain ID (the placeholder domain created by the claim)
Output: domain_claim with status, domain_id, the TXT record, blocked_reason, expires_at.
Argument: <id> — Domain ID (the placeholder domain created by the claim)
Triggers async verification + transfer. Poll domains claim get <id> for status. After completed, fetch the new DKIM records with domains get <id>, update DNS, then run domains verify <id>.