{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Common Workflows","description":"The developer documentation portal and API reference for Unstoppable Domains.","siteUrl":"https://docs.unstoppabledomains.com","keywords":"unstoppable domains developer portal, api reference docs","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"common-workflows","__idx":0},"children":["Common Workflows"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These workflows show how to accomplish common tasks with the CLI. Each one builds on the commands from the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/user-api/cli-commands"},"children":["Command Reference"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"register-a-new-domain","__idx":1},"children":["Register a New Domain"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Search for a domain, create a contact, add to cart, and purchase."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# 1. Search for available domains\nud search \"mybusiness\"\n\n# 2. Create an ICANN contact (required for first registration)\nud domains contacts create --data '{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"email\": \"jane@example.com\",\n  \"phone\": \"+1.5551234567\",\n  \"address1\": \"123 Main St\",\n  \"city\": \"San Francisco\",\n  \"state\": \"CA\",\n  \"postalCode\": \"94102\",\n  \"country\": \"US\"\n}'\n\n# 3. Add the domain to your cart\nud cart add registration mybusiness.com\n\n# 4. Review your cart\nud cart list\n\n# 5. Complete the purchase\nud cart checkout\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"set-up-dns-for-a-website","__idx":2},"children":["Set Up DNS for a Website"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configure A, CNAME, and MX records for a domain."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# View existing records\nud domains dns records show mybrand.io\n\n# Point the root domain to your server\nud domains dns records add mybrand.io --data '{\"type\":\"A\",\"hostName\":\"@\",\"value\":\"192.0.2.1\",\"ttl\":3600}'\n\n# Add a www CNAME\nud domains dns records add mybrand.io --data '{\"type\":\"CNAME\",\"hostName\":\"www\",\"value\":\"mybrand.io\",\"ttl\":3600}'\n\n# Add MX records for email (e.g., Google Workspace)\nud domains dns records add mybrand.io --data '{\"type\":\"MX\",\"hostName\":\"@\",\"value\":\"aspmx.l.google.com\",\"priority\":1,\"ttl\":3600}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["DNS changes can take up to 48 hours to propagate. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ud domains get <domain>"]}," to check for pending operations."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"bulk-dns-updates-from-a-file","__idx":3},"children":["Bulk DNS Updates from a File"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For multiple records, create a JSON file and import them at once."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# records.json\n# [\n#   {\"type\":\"A\",\"hostName\":\"@\",\"value\":\"192.0.2.1\",\"ttl\":3600},\n#   {\"type\":\"CNAME\",\"hostName\":\"www\",\"value\":\"mybrand.io\",\"ttl\":3600},\n#   {\"type\":\"MX\",\"hostName\":\"@\",\"value\":\"aspmx.l.google.com\",\"priority\":1,\"ttl\":3600}\n# ]\n\nud domains dns records add mybrand.io --file records.json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-a-domain-for-sale","__idx":4},"children":["List a Domain for Sale"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a marketplace listing and manage offers."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# List your domain for sale\nud marketplace listings create premium.com\n\n# Check for incoming offers\nud marketplace offers list\n\n# Respond to an offer\nud marketplace offers respond\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"buy-from-the-marketplace","__idx":5},"children":["Buy from the Marketplace"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Find and purchase a listed domain."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Search for the domain\nud search \"premium.com\"\n\n# Add the marketplace listing to your cart\nud cart add listed premium.com\n\n# Review the cart\nud cart list\n\n# Complete the purchase\nud cart checkout\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"manage-expiring-domains","__idx":6},"children":["Manage Expiring Domains"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Find domains that are about to expire and renew them."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Show domains expiring in the next 30 days\nud domains list --expiring-within 30\n\n# Enable auto-renewal\nud domains auto-renewal update mybrand.io\n\n# Or renew manually\nud cart add renewal mybrand.io\nud cart checkout\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"scripting-with-json-output","__idx":7},"children":["Scripting with JSON Output"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--format json"]}," and pipe to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jq"]}," for automation."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Get all domain names as a plain list\nud domains list --format json | jq -r '.[].name'\n\n# Find domains with active offers\nud domains list --format json | jq '[.[] | select(.offersCount > 0)]'\n\n# Export domain details to CSV\nud domains list --format csv > domains.csv\n\n# Count domains by TLD\nud domains list --format json | jq 'group_by(.name | split(\".\") | last) | map({tld: .[0].name | split(\".\") | last, count: length})'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"contact-a-domain-seller","__idx":8},"children":["Contact a Domain Seller"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reach out to the owner of a domain you're interested in."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Open a conversation with the seller\nud marketplace leads open\n\n# View your lead conversations\nud marketplace leads list\n\n# Send and read messages\nud marketplace leads messages list\nud marketplace leads messages send\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"generate-an-ai-landing-page","__idx":9},"children":["Generate an AI Landing Page"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create, check, and manage AI-generated landing pages for your domains."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Generate a landing page\nud domains hosting landers generate mybrand.com\n\n# Check the generation status\nud domains hosting landers show mybrand.com\n\n# Download the generated page\nud domains hosting landers download mybrand.com\n\n# Remove the landing page\nud domains hosting landers remove mybrand.com\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"backorder-an-expiring-domain","__idx":10},"children":["Backorder an Expiring Domain"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Browse expiring domains and set up automatic registration when they drop."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Browse expiring domains\nud marketplace expiring list\n\n# Filter by TLD and status\nud marketplace expiring list --tlds com,net --status AVAILABLE_BACKORDER\n\n# Create a backorder (use timestamp from expiring list output)\nud domains backorders create --name premium.com --contact-id <id> --available-after-timestamp <ts>\n\n# Check your backorders\nud domains backorders list\n\n# Cancel a backorder\nud domains backorders cancel --backorder-ids 12345\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"switch-between-environments","__idx":11},"children":["Switch Between Environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Test in sandbox before going to production."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Create an account or sign in on sandbox\nud auth signup --env sandbox\n# Or sign in to an existing account\nud auth login --env sandbox\n\n# Run commands against sandbox\nud search \"test.com\" --env sandbox\n\n# Or set sandbox as default\nud env set sandbox\n\n# Switch back to production\nud env set production\n","lang":"bash"},"children":[]}]},"headings":[{"value":"Common Workflows","id":"common-workflows","depth":1},{"value":"Register a New Domain","id":"register-a-new-domain","depth":2},{"value":"Set Up DNS for a Website","id":"set-up-dns-for-a-website","depth":2},{"value":"Bulk DNS Updates from a File","id":"bulk-dns-updates-from-a-file","depth":2},{"value":"List a Domain for Sale","id":"list-a-domain-for-sale","depth":2},{"value":"Buy from the Marketplace","id":"buy-from-the-marketplace","depth":2},{"value":"Manage Expiring Domains","id":"manage-expiring-domains","depth":2},{"value":"Scripting with JSON Output","id":"scripting-with-json-output","depth":2},{"value":"Contact a Domain Seller","id":"contact-a-domain-seller","depth":2},{"value":"Generate an AI Landing Page","id":"generate-an-ai-landing-page","depth":2},{"value":"Backorder an Expiring Domain","id":"backorder-an-expiring-domain","depth":2},{"value":"Switch Between Environments","id":"switch-between-environments","depth":2}],"frontmatter":{"title":"CLI Common Workflows | Unstoppable Domains Developer Portal","description":"Step-by-step guides for common domain management tasks using the Unstoppable Domains CLI.","seo":{"title":"Common Workflows"}},"editPage":{"to":"https://github.com/unstoppabledomains/dev-docs/blob/main/user-api/cli-workflows.md"},"lastModified":"2026-03-06T04:10:41.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/user-api/cli-workflows","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}