ListRestoreDrillJobs

July 21, 2025

This API can be list all completed restore drill jobs owned by a specified user.

The settings can be found on the AhsayCBS web console at:

  • Monitoring > Backup / Restore Logs > Restore Drill Jobs

URL

https://CBS.EXAMPLE.COM/obs/api/json/ListRestoreDrillJobs.do

Available Since Version: 9.9

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin, API or Read-Only API role.
SysPwd String Password matching SysUser.
LoginName String Username of the backup user.
Return Values
Key Type Description
Status String "OK" or "Error"
Data JSON Object See Data.
Message String Error message, it only appears if status displays "Error".
ExptType String The type of exception, will only be displayed if the status is "Error".
JSON Objects

Data

Key Type Description
RestoreDrillJob String Restore drill job ID in timestamp format (yyyy-mm-dd-HH-mm-ss).
BackupSetID String ID of the backup set.
DestinationID String ID of the destination.
Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm"
}

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"RestoreDrillJob":"2024-10-16-10-28-01",
			"BackupSetID":"1697422994935",
			"DestinationID":"1697423083118"
		},
		{
			"RestoreDrillJob":"2024-10-16-10-30-06",
			"BackupSetID":"1697422994935",
			"DestinationID":"1697423083118"
		}
	]
}
Documentation