DNS

Update a DNS record

Replaces a record in place (all fields required — fetch the current values first). Records flagged mailCritical are refused with 409 unless force: true is passed, because changing them can break the domain's email. Requires scope dns:write.

put/domains/{domain}/dns/records/{id}

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/domains/{domain}/dns/records/{id}
  • Auth: HTTP bearer

Path parameters

domainstring required

The domain name, e.g. yourdomain.com

idstring required

Record id from the list endpoint

Request body

type'A' | 'AAAA' | 'CNAME' | 'MX' | 'TXT' | 'SRV' | 'NS' | 'CAA' required
namestring required

Record name — a full hostname, or @ for the domain apex

valuestring required
ttlinteger

Time-to-live in seconds

priorityinteger

Priority for MX/SRV records

forceboolean

Confirm editing a mail-critical record

Example request

{
  "type": "A",
  "name": "app.yourdomain.com",
  "value": "203.0.113.20",
  "ttl": 3600,
  "priority": 10
}

Response

Record updated

successboolean

Example response

{
  "success": true,
  "data": {
    "ok": true
  }
}

Changes

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