ResellerHQ
Log inTry the sandbox free
GuidesAPI reference
DNS

Change a record

PATCH
/v1/domains/{id}/dns/records/{recordId}

Changes one record. Send only the fields you want to change. Changing the type to one that has no priority drops the priority with it.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Path Parameters

id*string
recordId*string

Request Body

application/json
  1. body
name?string

The record name. @ and the domain itself both mean the root; a bare label like www is taken as being under the domain. Stored and returned absolute and lower case

Length1 <= length <= 253
type?string

A and AAAA point at an IPv4 or IPv6 address. CNAME points a name at another name, and cannot sit at the root or beside any other record with the same name - use ALIAS at the root. MX needs a priority and points at a mail host. TXT holds free text, SRV a service at weight port target, CAA a flag tag "value" certificate rule, NS a delegation

Value in"A""AAAA""CNAME""MX""TXT""SRV""CAA""NS""ALIAS"
content?string

What the record answers with, in the form its type takes

Length1 <= length <= 4096
ttl?integer

How long resolvers may cache it, in seconds, from 60. Defaults to 3600

Range60 <= value <= 604800
priority?integer

Lower is tried first. Required on MX and SRV, and refused on every other type

Range0 <= value <= 65535

Response Body

One record in the zone we host for this domain

application/json
  1. response

One record in the zone we host for this domain

id*string
name*string

The record name. @ and the domain itself both mean the root; a bare label like www is taken as being under the domain. Stored and returned absolute and lower case

Length1 <= length <= 253
type*string

A and AAAA point at an IPv4 or IPv6 address. CNAME points a name at another name, and cannot sit at the root or beside any other record with the same name - use ALIAS at the root. MX needs a priority and points at a mail host. TXT holds free text, SRV a service at weight port target, CAA a flag tag "value" certificate rule, NS a delegation URL and MBOXFW are set only by forwarding (PUT /domains/{id}/forwarding, PUT /domains/{id}/email-forwarding) and read-only here

Value in"A""AAAA""CNAME""MX""TXT""SRV""CAA""NS""ALIAS""URL""MBOXFW"
content*string

What the record answers with, in the form its type takes

Length1 <= length <= 4096
ttl*integer

How long resolvers may cache it, in seconds, from 60. Defaults to 3600

Range60 <= value <= 604800
priority*|

The priority, or null on a type that has none. Always there

managedBy*|

Set when a forwarding feature made this record; change it from the forwarding settings instead of the generic record routes, which refuse it. Null otherwise

curl -X PATCH "https://example.com/v1/domains/dom_01K6XJ4Q8ZT3M9R5V2B7WDHNCA/dns/records/dns_01K6XJ4Q8ZT3M9R5V2B7WDHNCA" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "dns_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",  "name": "www.acme.com",  "type": "A",  "content": "203.0.113.10",  "ttl": 3600,  "priority": null,  "managedBy": null}

Replace every record PUT

Swaps the whole record set in one call, for keeping DNS in a system of your own. At most 200 records. Every record is checked first, so one bad record leaves the zone exactly as it was. The ids are new: these are new records, not edits of the ones they replace.

Delete a record DELETE

Removes one record from the zone. The rest of the zone is sent to the registrar as it now stands, because a zone is replaced whole.