Skip to content

Refresh status of several domains

POST /api/v2/domains/bulk/status-sync

Refresh the status of several domains from the registry. Use it when the status of a domain in your account looks out of date. It does not change nameservers, DNS records, contacts or auto-renew.

The whole batch is rejected when any domain ID is invalid or not in your account. The call queues a job and returns 202. Follow it at operation.pollUrl (Jobs). The job result has one row per domain and the counts success, skipped and failed.

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

Request

Body

domainIdsarray of stringrequired
Domain IDs (dom_…) to refresh. At least one.

Example

POST /api/v2/domains/bulk/status-sync
curl -X POST "https://cloud.hostup.se/api/v2/domains/bulk/status-sync" \
-H "Authorization: Bearer $HOSTUP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"domainIds": [
"dom_01hxa3b4c5d6e7f8g9h0j1k2m3",
"dom_01hxa3b4c5d6e7f8g9h0j1k2m4"
]
}'

Responses

202 Job queued. Follow it at operation.pollUrl.

Response 202
{
"operation": {
"status": "pending",
"jobId": "dbj_01hxa3b4c5d6e7f8g9h0j1k2m3",
"pollUrl": "/api/jobs/dbj_01hxa3b4c5d6e7f8g9h0j1k2m3"
},
"domainsQueued": 2
}
Response fields
operationobject
statusstring
Where the job is. A 202 Accepted response only has pending, queued or in_progress. completed and failed appear when you poll pollUrl. They also appear in a 200 OK response when the action finished during the request. One of pending, queued, in_progress, completed, failed.
jobIdstring
pollUrlstring or null
Where to poll the job while it runs. null when status is already completed or failed.
domainsQueuedinteger or null
Number of domains in the job.

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.
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.