GetServerRunJobStatus
July 21, 2025
This API can be used to retrieve detailed information of Run-on-Server (agentless) backup or restore jobs that are currently running.
The settings can be found on the AhsayCBS web console at:
- Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set > Execute Job
URL
https://CBS.EXAMPLE.COM/cbs/api/json/GetServerRunJobStatus.do
Available Since Version: 9.1
Parameters
Key | Type | Description |
---|---|---|
SysUser | String | Username of an AhsayCBS System User with Admin or API role. |
SysPwd | String | Password matching SysUser. |
User | String | Username of the backup user. |
Return Values
Key | Type | Description |
---|---|---|
Status | String | "OK" or "Error" |
Message | String | Error message, it only appears if status displays "Error". |
RunJob | Array of RunJob | Run on server (agentless) backup set status (backup, restore, dataIntegrityCheck, deleteBackupData). |
JSON Objects
RunJob
Key | Type | Description |
---|---|---|
IsEnableStopBtn | Boolean | True for manually run jobs, and False when it is a scheduled job or job where there is no Stop in the UI. |
BackupSetID | String | Backup set ID. |
ExecuteJob | String | Job currently running, empty if no running job. |
Example
INPUT
{
"SysUser":"system",
"SysPwd":"system1",
"LoginName":"obm"
}
OUTPUT
{
"Status":"OK",
"RunJob":[
{
"BackupSetID":"1687077919738",
"ExecuteJob":""
}
]
}