Skip to content

Get the status of a web hosting restore

GET /api/v2/shared-hosting/{accountId}/backups/queue/{queueRef}

Get the progress of a restore started by POST /api/v2/shared-hosting/{accountId}/backups/{snapshotId}/actions/restore or POST /api/v2/shared-hosting/{accountId}/backups/databases/{backupId}/actions/restore. Call the pollUrl those actions return. status is queued, running, completed or failed. On failed, error says what went wrong. A job that is unknown, belongs to another account or was cleared after it ended answers 404 job_not_found. The call also works while the account is suspended.

Authentication: An API key with the scopes read:hosting and console:services. About keys and scopes

Request

Path parameters

accountIdstringrequired
The web hosting account ID (acct_…).
queueRefstringrequired
The restore job ID (job_…) from operation.jobId.

Example

GET /api/v2/shared-hosting/{accountId}/backups/queue/{queueRef}
curl "https://cloud.hostup.se/api/v2/shared-hosting/acct_01hxa3b4c5d6e7f8g9h0j1k2m3/backups/queue/acct_01hxa3b4c5d6e7f8g9h0j1k2m3" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 The restore’s current status.

Response 200
{
"id": "job_01hxa3b4c5d6e7f8g9h0j1k2m3",
"status": "running",
"progressPercent": 45.5,
"createdAt": "2026-07-10T08:00:00.000Z",
"startedAt": "2026-07-10T08:00:05.000Z",
"completedAt": null,
"error": null
}
Response fields
idstring
The restore job ID (job_…).
statusstring
queued, running, completed or failed. completed also covers a restore that finished in part. One of queued, running, completed, failed.
progressPercentnumber or null
Progress from 0 to 100, when known. 0 to 100.
createdAtstring or null
When the restore was queued.
startedAtstring or null
When the restore started.
completedAtstring or null
When the restore ended.
errorstring or null
Why the restore failed. Null unless status is 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 job_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.
502Upstream failure. A dependent provider request failed; the Problem Details code is upstream_failed. Retry later or contact support if the issue persists.