Get status and progress of ongoing jobs

Check the status of a specific job, such as a domain operation. The endpoint returns detailed information about the job, including its current status, progress, and whether it has completed or failed. If the job results in an invoice or order, it also returns relevant IDs for follow-up calls.

Account & Access Service Inventory

Context

Workflow links

Path Parameters

jobId string required Example: check-example-1700000000000

jobId parameter

Headers

Accept Example
Content-Type Example

Responses

200
data object required
data.createdAt string required · Example: 2026-02-10T00:00:00.000Z
data.delay string · nullable required · Example: null

Nullable: may be null when not applicable.

data.finishedAt string · nullable required · Example: 2026-02-10T00:00:00.000Z

Nullable: may be null when not applicable.

data.hostbillAccountId string · Example: 20000
data.isCompleted boolean · Example: true
data.isFailed boolean · Example: false
data.isRunning boolean · Example: false
data.isScheduled boolean · Example: false
data.isWaiting boolean · Example: false
data.jobId string · Example: restore-1002-1700000000002
data.jobName string · Example: restore-10000
data.progress integer · Example: 100
data.progressDetails string · nullable · Example: null

Nullable: may be null when not applicable.

data.progressMessage string · nullable · Example: null

Nullable: may be null when not applicable.

data.progressTextKey string · Example: instance.jobs.completed_successfully
data.queueType string · Example: vm
data.result object · nullable

Nullable: may be null when not applicable.

data.result.proxmoxVmId string required · Example: 10000
data.result.result object required
data.result.result.ipReapply object
data.result.result.ipReapply.applied boolean required · Example: true
data.result.result.ipReapply.warnings array<object> required · Example: []
data.result.result.message string required · Example: Restore completed and VM started successfully

Human-readable message.

data.result.result.mode string · Example: snapshot
data.result.result.resourceSync object
data.result.result.resourceSync.applied boolean required · Example: true
data.result.result.resourceSync.diskDeltaGb integer required · Example: 75
data.result.result.resourceSync.isCloudVm boolean required · Example: false
data.result.result.resourceSync.targetCores integer · Example: 4
data.result.result.resourceSync.targetDiskGb integer · Example: 275
data.result.result.resourceSync.targetMemoryMb integer · Example: 16384
data.result.result.resourceSync.warnings array<object> · Example: []
data.result.result.size integer · Example: 268435457225
data.result.result.startUpid string · Example: UPID:node1:00010000:00000001:00000001:qmstart:10000:user@pve:
data.result.result.upid string required · Example: UPID:node1:00010000:00000001:00000001:qmrestore:10000:user@pve:
data.result.result.vmRestarted boolean · Example: false
data.result.result.volid string · Example: pbs-offsite-10g:backup/vm/10000/2026-02-10T00:00:00.000Z
data.result.success boolean required · Example: true

True for successful responses.

data.result.timestamp string · Example: 2026-02-10T00:00:00.000Z

ISO 8601 timestamp (UTC).

data.result.type string · enum · Example: restore
backup
restore
data.result.vmId string · Example: 10000
data.state string · enum · Example: completed
active
completed
data.status string · enum · Example: completed
completed
running
data.statusKey string · Example: instance.jobs.completed_successfully
data.type string · enum · Example: restore
backup
restore
data.vmId string · Example: 10000
requestId string required · Example: 2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba

Unique request identifier (UUID).

success boolean required · Example: true

True for successful responses.

timestamp string · Example: 2026-02-10T00:00:00.000Z

ISO 8601 timestamp (UTC).

429
error string required · Example: Too Many Requests

HTTP status title (e.g. 'Bad Request').

message string required · Example: Rate limit exceeded. Please try again later.

Human-readable message.

requestId string required · Example: 2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba

Unique request identifier (UUID).

retryAfter string · Example: 2026-02-10T00:00:00.000Z

When to retry (ISO 8601 timestamp, UTC).

GET https://cloud.hostup.se/api/jobs/{jobId}
For AI assistants
cURL 
curl -X GET "https://cloud.hostup.se/api/jobs/check-example-1700000000000" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"
Response 
{
  "success": true,
  "timestamp": "2026-02-10T00:00:00.000Z",
  "requestId": "2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba",
  "data": {
    "jobId": "restore-1002-1700000000002",
    "queueType": "vm",
    "type": "restore",
    "state": "completed",
    "status": "completed",
    "progress": 100,
    "progressTextKey": "instance.jobs.completed_successfully",
    "progressDetails": null,
    "progressMessage": null,
    "result": {
      "success": true,
      "type": "restore",
      "vmId": "10000",
      "proxmoxVmId": "10000",
      "result": {
        "message": "Restore completed and VM started successfully",
        "upid": "UPID:node1:00010000:00000001:00000001:qmrestore:10000:user@pve:",
        "startUpid": "UPID:node1:00010000:00000001:00000001:qmstart:10000:user@pve:",
        "resourceSync": {
          "applied": true,
          "isCloudVm": false,
          "targetCores": 4,
          "targetMemoryMb": 16384,
          "targetDiskGb": 275,
          "diskDeltaGb": 75,
          "warnings": []
        },
        "ipReapply": {
          "applied": true,
          "warnings": []
        }
      },
      "timestamp": "2026-02-10T00:00:00.000Z"
    },
    "isCompleted": true,
    "isFailed": false,
    "isRunning": false,
    "isWaiting": false,
    "createdAt": "2026-02-10T00:00:00.000Z",
    "finishedAt": "2026-02-10T00:00:00.000Z",
    "jobName": "restore-10000",
    "vmId": "10000",
    "hostbillAccountId": "20000",
    "isScheduled": false,
    "delay": null,
    "statusKey": "instance.jobs.completed_successfully"
  }
}