AccountHostnames

Check a hostname now

POST
/v1/account/hostnames/{id}/check

Runs the CNAME check immediately, the same one the worker runs in the background, and reaches it even if repeated failure has parked 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

Response Body

Success

application/json
  1. response

Success

id*string
hostname*string
kind*string

subdomain is a label under your own portal address; custom is a domain of yours

Value in"subdomain""custom"
status*string

pending until its CNAME is confirmed, or always verified for a subdomain

Value in"pending""verified""failed"
attempts*integer

Failed CNAME checks so far

lastCheckedAt*|
Formatdate-time
verifiedAt*|
Formatdate-time
failure*|

Why the most recent check failed. Null once verified, and before the first check

createdAt*string
Formatdate-time
cnameTarget*|

What a custom hostname's CNAME must point at. Null for a subdomain one

curl -X POST "https://example.com/v1/account/hostnames/hst_01K6XJ4Q8ZT3M9R5V2B7WDHNCA/check"
{  "id": "hst_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",  "hostname": "shop.northwind.example",  "kind": "subdomain",  "status": "pending",  "attempts": 0,  "lastCheckedAt": null,  "verifiedAt": null,  "failure": null,  "createdAt": "2026-10-07T11:04:31.000Z",  "cnameTarget": "portal.rhq.app"}