Deployments.ai Docs
Command reference

deployments email-domain

Send-only domain ownership and DNS verification

CommandSummary
deployments email-domain createRegister a sending domain ownership challenge
deployments email-domain listList a tenant's sending domains
deployments email-domain getGet sending domain DNS and verification state
deployments email-domain refreshRefresh sending domain ownership and DNS verification
deployments email-domain revokeRevoke 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 (SDK createEmailDomain).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<tenantId>positionalyesSending tenant ID
--domainstringyesDNS 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 (SDK listEmailDomains).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
<tenantId>positionalyesSending tenant ID

Also accepts the global flags.

deployments email-domain get

Get sending domain DNS and verification state.

deployments email-domain get <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource 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 (SDK refreshEmailDomain).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource 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} (SDK revokeEmailDomain).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

On this page