Skip to content

List running jobs on a VPS

GET /api/v2/vps/{id}/active-jobs

Lists the jobs that are queued or running on a VPS, such as backups, restores and rebuilds. Check actions.canPerformActions before you start another action on the VPS. It is false while a backup or another blocking job runs. A restore reports its phase and speed in restoreProgress. To follow an action you started yourself, poll the operation.pollUrl from its response (Jobs).

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

Request

Path parameters

idstringrequired
The VPS ID (vps_…).

Example

GET /api/v2/vps/{id}/active-jobs
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/active-jobs" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 Jobs on the VPS and whether new actions can start.

Response 200
{
"jobs": [
{
"id": "job_01hxa3b4c5d6e7f8g9h0j1k2m3",
"type": "backup",
"status": "in_progress",
"progress": 45,
"name": null,
"jobName": null,
"isScheduled": false,
"createdAt": "2026-04-27T12:00:00.000Z",
"statusText": "Backup is running",
"progressDetailText": null,
"restoreProgress": null,
"reason": null,
"error": null
}
],
"hasActiveBackup": true,
"hasActiveOperation": false,
"actions": {
"canPerformActions": {
"allowed": false,
"reason": "A backup is currently running. Try again after it finishes."
}
}
}
Response fields
jobsarray of object
idstring
Job ID.
typestring
Kind of job, for example backup, restore, rebuild, start, stop, restart, snapshot_rollback or upgrade. unknown when the type is not known.
statusstring
queued or in_progress. One of queued, in_progress.
progressnumber
Progress in percent, 0 to 100.
namestring or null
A display name, when the job has one. Usually null: label the job from type and statusText.
jobNamestring or null
Always null. Kept for older clients.
isScheduledboolean
True when a schedule started the job.
createdAtstring or null
statusTextstring or null
Short status text to show.
progressDetailTextstring or null
Detail of the current step, when the job reports one.
restoreProgressobject or null
Progress of a restore. Null for other jobs and before a restore reports progress.
reasonstring or null
Extra status message from the job, when there is one.
errorstring or null
Error message when the job has failed a step.
hasActiveBackupboolean
True while a backup is queued or running.
hasActiveOperationboolean
True while a job that blocks other actions runs, such as a start, stop, restore, snapshot rollback or rebuild. A backup alone sets hasActiveBackup instead.
actionsobject
canPerformActionsobject
Whether a new action can start on the VPS now.
allowedboolean
reasonstring or null

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.
404No VPS with this ID, or it belongs to another account (vps_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.