Setup DNS For Domain

Manually trigger DNS setup for a purchased domain.

If DNS setup was not enabled during purchase, use this endpoint to set it up. Returns status and estimated completion time.

POST /api/v1/registrar/domains/{domain}/setup-dns

Setup Dns For Domain

cURL

curl --request POST \
  --url https://api.dotlet.net/api/v1/registrar/domains/{domain}/setup-dns \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "dns_provider": "cloudflare"
}
'

200

{
  "message": "<string>",
  "status": "<string>",
  "zone_id": "<string>",
  "nameservers": [],
  "provider": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "progress": {
    "zone_created": false,
    "ns_updated_at_registrar": false,
    "ns_delegation_verified": false
  },
  "dns_api_ready": true,
  "error": "<string>",
  "estimated_completion": "<string>",
  "status_url": "<string>",
  "dns_endpoints": {}
}

Authorizations

APIKeyHeaderHTTPBearer

X-API-Key · string · header · required

Path Parameters

domain · string · required

Body

application/json

Request to setup DNS for a purchased domain

dns_provider · string · default: cloudflare

Required string length: 1 - 50

Response

200

application/json

Successful Response

Response from DNS setup request

message · string · required

status · string · required

zone_id · string | null

nameservers · string[]

provider · string | null

started_at · string<date-time> | null

updated_at · string<date-time> | null

completed_at · string<date-time> | null

progress · DNSSetupProgressResponse · object | null

DNS setup progress details

Show child attributes

dns_api_ready · boolean | null

error · string | null

estimated_completion · string | null

status_url · string | null

dns_endpoints · Dns Endpoints · object | null