AccountBranded nameservers
Check your branded nameserver set
POST
Checks that each name still resolves, from outside, to the addresses its host record was given, and updates its status accordingly.
apiKeyheader
AuthorizationBearer <token>An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.
Success
application/json- response
Success
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/check"{ "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"}