v14

latestOpenAPI 3.0.32026-08-04377889.4 MB

dns

Update an existing DNS record

Updates an existing DNS record for a domain name.

patch/v1/domains/records/{recordId}

Path parameters

recordIdstring required

The id of the DNS record

Example:rec_2qn7pzrx89yxy34vezpd31y9

The id of the DNS record

Query parameters

teamIdstring

Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring

Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

namestring nullable

The name of the DNS record

valuestring nullable

The value of the DNS record

type'A' | 'AAAA' | 'ALIAS' | 'CAA' | 'CNAME' | 'HTTPS' | 'MX' | 'SRV' | 'TXT' | 'NS' | 'null' nullable

The type of the DNS record

ttlinteger nullable

The Time to live (TTL) value of the DNS record

mxPriorityinteger nullable

The MX priority value of the DNS record

commentstring

A comment to add context on what this DNS record is for

Example request

{
  "name": "example-1",
  "value": "google.com",
  "type": "A",
  "srv": {
    "target": "example2.com."
  },
  "https": {
    "target": "example2.com."
  },
  "comment": "used to verify ownership of domain"
}

Response

idstring required

namestring required

type'record' | 'record-sys' required

valuestring required

creatorstring required

domainstring required

ttlnumber

commentstring

createdAtnumber nullable