AhsayCBSDeleteBackupFile
July 21, 2025
This API only works for backups from version 6 or older backup clients.
URL
https://CBS.EXAMPLE.COM/obs/api/json/DeleteBackupFile.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. |
| LoginName | String | Username of the backup user. |
| BackupSetName | String | Either backup set ID or backup set name should be provided. |
| InBackupJob | String | Backup job ID. |
| Path | String | Path to the backup files. |
| Type | String | Backup type, can be one of the following: F, D or I. |
| BackupByJob | String | Backup job ID. |
Return Values
| Key | Type | Description |
|---|---|---|
| Status | String | "OK" or "Error" |
| 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". |