Point a domain at a deployment
connect_domainPoint a domain the user owns on namemy.app at their deployment in one call: writes the platform's root and www records, replacing existing A/AAAA/CNAME records on those two hosts (other records are kept). Free. Returns the records applied and removed, plus nextSteps the user must do on the platform (e.g. add the domain in the Vercel project settings, or copy a verification TXT record). On failure, restored: true means nothing changed; restored: false comes with live, the records in place now (null if unknown), which is what to report. [Requires a free namemy.app API key — get one at https://namemy.app/app/api-keys]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| value | No | The platform's hostname for the deployment: my-site.netlify.app, my-app.pages.dev, octocat.github.io, my-app.onrender.com, the *.up.railway.app target Railway shows after you add the domain there, or the my-app.fly.dev hostname / public IP from `fly certs setup`. Optional for vercel (only if its dashboard shows a *.vercel-dns*.com CNAME for www). | |
| domain | Yes | Domain the user owns, e.g. 'taskflow.dev' | |
| dryRun | No | Validate and return the records that would be written, without changing anything | |
| target | Yes | ||
| includeWww | No | Also point www at the deployment |