vercel domains
The vercel domains command manages domains under the current scope. With it, you can list, inspect, verify, add, remove, purchase, renew, move, transfer in, search, price, check the availability of, and manage automatic renewal for domains.
vercel domains lsUsing the vercel domains command to list all domains
under the current scope.
vercel domains inspect [domain]Using the vercel domains command to retrieve
information about a specific domain.
vercel domains verify [domain]Using the vercel domains command to verify the DNS
configuration of a domain.
vercel domains add [domain] [project]Using the vercel domains command to add a domain to
the current scope or a Vercel Project.
vercel domains rm [domain]Using the vercel domains command to remove a domain
from the current scope.
vercel domains buy [domain]Using the vercel domains command to buy a domain for
the current scope.
vercel domains search [query]Using the vercel domains command to discover
domain candidates from a keyword or domain fragment.
vercel domains price [domain] [...domain]Using the vercel domains command to return
pricing for one or more domains.
vercel domains check [domain] [...domain]Using the vercel domains command to check
availability for one or more domains.
vercel domains move [domain] [scope-name]Using the vercel domains command to move a domain to
another scope.
vercel domains transfer-in [domain]Using the vercel domains command to transfer in a
domain to the current scope.
vercel domains renew [domain]Using the vercel domains command to renew a
registered domain before it expires. The command shows the renewal
price and term, then asks you to confirm the charge.
vercel domains auto-renew [domain] [on|off]Using the vercel domains command to turn automatic
renewal on or off for a registered domain. Both the domain and the
on|off state are required.
These are options that only apply to the vercel domains command.
Use the --yes option to bypass the confirmation prompt when removing a domain.
vercel domains rm [domain] --yesUsing the vercel domains rm command with the
--yes option.
Use the --limit option to specify the maximum number of domains that ls returns. The default value is 20 and the maximum is 100.
vercel domains ls --limit 100Using the vercel domains ls command with the
--limit option.
You can also use the --limit option with search to specify the number of domain candidates to check per page. The default value is 20 and the maximum is 200.
vercel domains search acme --limit 200Using the vercel domains search command with the
--limit option.
The --next option enables pagination when listing domains. Pass the timestamp (in milliseconds since the UNIX epoch) from a previous response to get the next page of results.
vercel domains ls --next 1584722256178Using the vercel domains ls command with the
--next option for pagination.
You can also use the --next option with search to fetch the next page of candidates. Pass the cursor returned in the previous search response or printed in the continuation command.
vercel domains search acme --next [cursor]Using the vercel domains search command with the
--next option for pagination.
The --force option forces a domain on a project, removing it from an existing one.
vercel domains add my-domain.com my-project --forceUsing the vercel domains add command with the
--force option.
Use the --available option with search to show only domain candidates that are available to register.
vercel domains search acme --availableUsing the vercel domains search command with the
--available option.
Use the --order option with search to order candidates by relevance, alphabetical, or length. The default value is relevance.
vercel domains search acme --order alphabeticalUsing the vercel domains search command with the
--order option.
Use the --tld option with search to filter candidates by exact top-level domain. Repeat the option to search multiple TLDs.
vercel domains search acme --tld com --tld devUsing the vercel domains search command with the
--tld option.
Use the --format=json option with search to return structured JSON output.
vercel domains search acme --format=jsonUsing the vercel domains search command with the
--format=json option.
You can also use the --format=json option with verify to return structured JSON output describing the current and expected DNS records for the domain.
vercel domains verify my-domain.com --format=jsonUsing the vercel domains verify command with the
--format=json option.
You can also use the --format=json option with renew to print the renewal result as structured JSON. The renewal still requires an interactive confirmation of the charge before the JSON result is printed.
vercel domains renew my-domain.com --format=jsonUsing the vercel domains renew command with the
--format=json option.
You can also use the --format=json option with auto-renew to return a structured JSON result describing the domain's new automatic renewal state.
vercel domains auto-renew my-domain.com on --format=jsonUsing the vercel domains auto-renew command with the
--format=json option.
Use the --project option with verify to check the DNS configuration against the records expected by a specific Vercel Project.
vercel domains verify my-domain.com --project my-projectUsing the vercel domains verify command with the
--project option.
Use the --strict option with verify to check DNS for the exact domain only, without falling back to the parent zone's configuration.
vercel domains verify my-domain.com --strictUsing the vercel domains verify command with the
--strict option.
The following global options can be passed when using the vercel domains command:
--cwd--debug--global-config--help--local-config--no-color--non-interactive--scope--team--token--version
For more information on global options and their usage, refer to the options section.
Was this helpful?