AccountBranded nameservers
Create your branded nameserver set
POST
2 to 4 hostnames under a domain you hold with us, each given a host record and checked at once, so a correctly-pointed set comes back already ready rather than making you poll. Refused while you already have a set: remove it first.
apiKeyheader
AuthorizationBearer <token>An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.
application/json- body
carrierDomainId*stringA domain you hold with us
names*array<>Each a hostname under the carrier domain, like ns1.acme-hosting.com
Created
application/json- response
Created
id*stringcarrierDomainId*stringcarrierDomain*stringnames*array<string>2 to 4 hostnames under the carrier domain
status*stringready once every name resolves to its expected addresses
Value in
"pending""ready""failed"checks*array<>usedByCount*integerDomains in your account currently using these names as their nameservers
createdAt*stringFormat
date-timeupdatedAt*stringFormat
date-timecurl -X POST "https://example.com/v1/account/branded-nameservers" \ -H "Content-Type: application/json" \ -d '{ "carrierDomainId": "dom_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "names": [ "ns1.acme-hosting.com", "ns2.acme-hosting.com" ] }'{ "id": "bns_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "carrierDomainId": "dom_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "carrierDomain": "acme-hosting.com", "names": [ "ns1.acme-hosting.com", "ns2.acme-hosting.com" ], "status": "pending", "checks": [ { "name": "ns1.acme-hosting.com", "status": "pending", "lastCheckedAt": null, "failure": null } ], "usedByCount": 0, "createdAt": "2026-10-07T11:04:31.000Z", "updatedAt": "2026-10-07T11:04:31.000Z"}