Domains

Set up a domain you already own

Queue an already-registered domain for setup: configures DNS and sets up email infrastructure (async). This endpoint does NOT register the domain at a registrar and never charges for registration. To buy and register a new domain, use POST /v1/domains/purchase. Requests with register: true are rejected with a 400 error.

post/v1/domains/setup

Request

Base URL: https://api.winnr.app
URL: https://api.winnr.app/v1/domains/setup
Auth: HTTP bearer

Request body

domainstring required

Domain name to set up. Must already be registered (you own it at an external registrar, or bought it via /v1/domains/purchase).

setup_dnsboolean

Create the DNS zone and mail records (SPF, DKIM, DMARC, MX).

setup_emailboolean

Create the domain on the mail infrastructure.

redirect_urlstring nullable

Optional URL the domain root should redirect to.

tagsstring[]

Optional tags applied to the domain.

Response

Domain setup queued

Example response

{
  "data": {
    "progress": {
      "registration": "completed",
      "mailcow": "completed",
      "dns_zone": "in_progress",
      "dns_records": "pending"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.