Command reference
deployments email-domain
Send-only domain ownership and DNS verification
| Command | Summary |
|---|---|
deployments email-domain create | Register a sending domain ownership challenge |
deployments email-domain list | List a tenant's sending domains |
deployments email-domain get | Get sending domain DNS and verification state |
deployments email-domain refresh | Refresh sending domain ownership and DNS verification |
deployments email-domain revoke | Revoke a sending domain |
deployments email-domain create
Register a sending domain ownership challenge.
deployments email-domain create <tenant-id> --domain <domain>- Calls
POST /v1/email/tenants/{tenantId}/domains(SDKcreateEmailDomain). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<tenantId> | positional | yes | Sending tenant ID | |
--domain | string | yes | DNS domain name |
Also accepts the global flags.
deployments email-domain list
List a tenant's sending domains.
deployments email-domain list <tenant-id>- Calls
GET /v1/email/tenants/{tenantId}/domains(SDKlistEmailDomains). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<tenantId> | positional | yes | Sending tenant ID |
Also accepts the global flags.
deployments email-domain get
Get sending domain DNS and verification state.
deployments email-domain get <id>- Calls
GET /v1/email/domains/{domainId}(SDKgetEmailDomain). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments email-domain refresh
Refresh sending domain ownership and DNS verification.
deployments email-domain refresh <id>- Calls
POST /v1/email/domains/{domainId}/refresh(SDKrefreshEmailDomain). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments email-domain revoke
Revoke a sending domain.
deployments email-domain revoke <id>- Calls
DELETE /v1/email/domains/{domainId}(SDKrevokeEmailDomain). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.