getCurrentBackupJob

GET

/api/v1/system/backups/jobs/current

const url = 'https://example.com/api/v1/system/backups/jobs/current';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/system/backups/jobs/current

Read the current backup job, if any. Requires an Owner with the admin scope.

Responses

200

Current backup job. The live worker heartbeat when a job is running, otherwise the stored current job.

application/json

object

data

required

One of:

object
object

Live in-memory worker heartbeat for the active job. Unlike the stored BackupJob, it carries no trigger, archive link, timestamps, or error detail.

object

jobId

required

string format: uuid

kind

required

string

status

required

string

phase

required

string

progressPercent

required

integer

<= 100

Example

{
  "data": {
    "kind": "backup"
  }
}

401

Dashboard authentication required

403

Insufficient role