Skip to content

Refresh a domain's status

POST /api/v2/domains/{id}/actions/status-sync

Read the domain’s status from the registry again and save it. Use it when a transfer or registration has finished at the registry but the domain still shows pending. Send no body or an empty object. The response has the status before and after. statusChanged says whether it changed.

Authentication: An API key with the scope read:domains. About keys and scopes

Request

Path parameters

idstringrequired
The domain ID (dom_…).

Example

POST /api/v2/domains/{id}/actions/status-sync
curl -X POST "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/status-sync" \
-H "Authorization: Bearer $HOSTUP_API_KEY" \
-H "Content-Type: application/json"

Responses

200 The status before and after the refresh.

Response 200
{
"id": "dom_01hxa3b4c5d6e7f8g9h0j1k2m3",
"name": "example.com",
"previousStatus": "pending",
"newStatus": "active",
"statusChanged": true,
"statusChangedToActive": true,
"syncSuccess": true,
"info": "Domain status was updated.",
"error": null,
"revertAttempted": false,
"revertSucceeded": false,
"revertError": null,
"doubleSyncAttempted": false,
"doubleSyncSucceeded": false,
"doubleSyncError": null
}
Response fields
idstring
The domain ID.
namestring
The domain name.
previousStatusstring
The status before the refresh. One of active, suspended, terminated, pending, cancelled, expired, fraud, transferred_out, unknown.
newStatusstring
The status after the refresh. One of active, suspended, terminated, pending, cancelled, expired, fraud, transferred_out, unknown.
statusChangedboolean
True when the status changed.
statusChangedToActiveboolean
True when the domain became active.
syncSuccessboolean
False when the registry could not be read.
infostring or null
A short English sentence about the outcome when the refresh worked.
errorstring or null
A short English sentence when the refresh failed.
revertAttemptedboolean
True when the refresh produced a wrong status and it was put back.
revertSucceededboolean
True when putting the status back worked.
revertErrorstring or null
Set when putting the status back failed.
doubleSyncAttemptedboolean
True when a second refresh was run.
doubleSyncSucceededboolean
True when the second refresh worked.
doubleSyncErrorstring or null
Set when the second refresh failed.

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller; code is domain_not_found.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.